Block a Number

This API allows you to block a number against the DID/Account.

Sample Request

curl --request POST \
     --url \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"block_key":"did"}'

📘 Important!

Before we begin, note that the * sign denotes the mandatory variables in each table.

Request Variables (Body Params)

The following parameter is required to block a number:

Variable NameDescriptionData Type
src_number*Source Number that needs to be blocked, between 5-50.string
block_key*Type against which the number should be blocked.string
did_numbers*my_numbers against which the number should be blocked, only requried for block_key=did.array of strings

Response Variables

The response returned is as following:

Variable NameDescriptionData Type
SuccessThe request success status, the possible values are: True (default) for success. False for failure.Boolean
MessageThe message corresponding to the success status. For example, in 400 Response where the "success" variable pops as True, the message displayed is shown here.String
Click Try It! to start a request and see the response here!