Sign in
latestOpenAPI 3.0.3MIT2026-08-124627160.3 KB

c04c2c708bf9

Call Blocking Rules

Get call blocking rules

Return all the call blocking rules for the specified project.

get/callBlockingRules

Query parameters

pageinteger

The page you want to fetch, can set to 1 for first page, or omitted for first page

sizeinteger

The size of each page to fetch

sortstring[]

An array setting the sorting criteria in the format of property,(ascending/descending)

Response

OK

namestring

The name for the call blocking rule.

direction'INBOUND' | 'OUTBOUND' required

The direction of the call blocking rule. Can be either INBOUND or OUTBOUND.

callerCountrystring

The country code of the inbound call.

calleeCountrystring

The country code of the outbound call.

callerMatchstring

Use this field to match the prefixes of an inbound call's phone number.

calleeMatchstring

Use this field to match the prefixes of an outbound call's phone number.

idstring

The ID of the call blocking rule.

Example response

[
  {
    "name": "My Call Block Rule",
    "direction": "INBOUND",
    "callerCountry": "US",
    "calleeCountry": "CA",
    "callerMatch": "123",
    "calleeMatch": "456",
    "id": "01KG5BN8Z0HSR2P9GM3K9YA8RE"
  }
]