Query Information of a PIN List

Query the detailed information of a PIN list.

Request URL

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

Request parameters

Table 1.
Parameter Required Type Description
id Yes Integer The unique ID of a PIN list.
Note: You can query PIN list's ID using Search Specific PIN Lists.

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 <PINList_Info> The information of the PIN list.
Table 3.
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


Request example

GET /openapi/v1.0/pin_list/get?id=13&access_token=ojPrvnfzPdwc8OCcRmhG16gEHuZcwFco HTTP/1.1
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