Add a PIN List

Add and configure a PIN list.

Request URL

POST {base_url}/{api_path}/pin_list/create?access_token={access_token}

Request parameters

Table 1.
Parameter Required Type Description
name Yes String The name of the PIN list.
pin_list Yes String The PIN codes.
Note: Use a comma to separate multiple PIN codes.
enb_record_cdr No Integer Whether to record the PIN code in CDR when the PIN code has been used.

Valid value:

  • 0: No
  • 1: Yes

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.
id Integer The unique ID of the PIN list.


Request example

POST /openapi/v1.0/pin_list/create?access_token=ojPrvnfzPdwc8OCcRmhG16gEHuZcwFco HTTP/1.1
Content-Type: application/json

Response example

HTTP/1.1 200 OK
    "errcode": 0,
    "errmsg": "SUCCESS",
    "id": 10