Skip to Content

Edit a Blocked Number Rule

Edit the configuration of a call blocklist rule.

Request URL

POST {base_url}/{api_path}/block_numbers/update?access_token={access_token}

Request parameters

ParameterRequiredTypeDescription
idYesIntegerThe unique ID of a call blocklist rule.
Note: You can query call blocklist rule's ID using Search Specific Blocked Numbers Rules.
nameNoStringThe name of the call blocklist rule.
limit_typeNoStringThe communication type that will be applied to the call blocklist rule.

Valid value:

  • inbound: Block the number(s) from calling into the PBX.
  • outbound: Block PBX extensions from calling the number(s).
  • both: Block the number(s) from calling into the PBX and block the PBX extensions from calling the number(s).
number_listNoStringThe numbers that will be blocked by the system.
Note: Use & to separate multiple numbers.

Response parameters

ParameterTypeDescription
errcodeIntegerReturned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note:You can check the error code and error message in Error Code and Error Message.
errmsgStringReturned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.

Examples

Request example

POST /openapi/v1.0/block_numbers/update?access_token=SX7P7AvcZdEJcr275lJcIP5BdWZDIPIH HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
    "id":5,
    "limit_type":"both"
}

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}