Query Information of a Blocked Number Rule

Query the detailed information of a call blocklist rule.

Request URL

GET {base_url}/{api_path}/block_numbers/get?access_token={access_token}

Request parameters

Table 1.
Parameter Required Type Description
id Yes Integer The unique ID of a call blocklist rule.
Note: You can query call blocklist rule's ID using Search Specific Blocked Numbers Rules.

Response parameters

Table 2.
Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
data Object <BlockedNumbers_Info> The detailed information of the blocked numbers' information.
BlockedNumbers_Info
Table 3.
Parameter Type Description
id Integer The unique ID of the blocklist rule.
name String The name of the blocklist rule.
limit_type String The communication type that applies to the blocklist rule.
number_list String The numbers that will be blocked by the system.

Examples

Request example

GET /openapi/v1.0/block_numbers/get?access_token=OPmgiTyngN4XJrvYAYepnmVJdggXbOjF&id=3 HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "block_number_info": {
        "id": 3,
        "name": "Fraud Calls",
        "limit_type": "inbound",
        "number_list": "82469079"
    }
}