Query Information of an Allowed Number Rule

Request URL

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

Request parameters

Table 1.
Parameter	Required	Type	Description
id	Yes	Integer	The unique ID of a call allowlist rule. Note: You can query call allowlist rule's ID using Search Specific Allowed 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 <AllowedNumbers_Info>	The detailed information of the allowed numbers' information.

AllowedNumbers_Info

Table 3.
Parameter	Type	Description
id	Integer	The unique ID of the allowlist rule.
name	String	The name of the allowlist rule.
limit_type	String	The communication type that applies to the allowlist rule.
number_list	String	The numbers that will be allowed by the system.

Examples

Request example

GET /openapi/v1.0/allow_numbers/get?access_token=DfwoCmAqPuexIOQH1NY7j8l8U391niHD&id=1 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "allow_number_info": {
        "id": 1,
        "name": "Dependable Calls",
        "limit_type": "both",
        "number_list": "12355"
    }
}