Create a call blocking rule

Adds an inbound blocking rule, then rebuilds and reloads your account's call blocking routing so it applies to the next call. New rules are created enabled with a match count of zero. The new rule's ID is not returned, so list the rules again to find it. If your key is limited to specific extensions and you send no extension_uuid, or one you do not hold, a separate rule is created for each extension you do hold.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

Display name for the rule. Whitespace is trimmed and an empty value is stored as no name.

string | null

The calling number to block. Trimmed, and an empty value is stored as no number.

string | null

Free-text note about the rule. Trimmed, and an empty value is stored as no note.

string

Limit the rule to one extension. Send all or leave it empty to apply the rule across your whole account.

string | null

Category of the action applied to a blocked call.

string | null

The action taken on a blocked call. reject, busy and hold clear call_block_data.

string | null

Argument for the action, such as a destination. Ignored for reject, busy and hold.

number | null

Country code stored alongside the blocked number.

string

Call direction the rule applies to. Defaults to inbound.

string

Internal field. Omit it; rules are created on your own account.

Responses

401

Missing or invalid API key.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json