Query Information of Multiple PIN Lists

Query the detailed information of multiple PIN lists at the same time.

Request URL

GET {base_url}/{api_path}/pin_list/query?access_token={access_token}

Request parameters

Parameter	Required	Type	Description
ids	Yes	String	The unique ID(s) of PIN list(s). Note: You can query PIN list's ID using Search Specific PIN Lists. Use a comma to separate multiple IDs.

Response parameters

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	Array <PINList_Info>	The information of each PIN list.

PINList_Info

Parameter	Type	Description
id	Integer	The unique ID of the PIN list.
name	String	The name of the PIN list.
pin_list	String	The PIN codes.
enb_record_cdr	Integer	Whether to record the PIN code in CDR when the PIN code has been used. 0: No 1: Yes

Examples

Request example

GET /openapi/v1.0/pin_list/query?id=13,14&access_token=ojPrvnfzPdwc8OCcRmhG16gEHuZcwFco HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": [
        {
            "id": 13,
            "name": "local_calls",
            "pin_list": "2283,3301",
            "enb_record_cdr": 0
        },
        {
            "id": 14,
            "name": "lnternational_calls",
            "pin_list": "4865,7203,5501",
            "enb_record_cdr": 1
        }
    ]
}