Search Specific PIN Lists
Search specific PIN lists.
Request URL
GET {base_url}/{api_path}/pin_list/search?access_token={access_token}
Request parameters
Parameter | Required | Type | Description |
---|---|---|---|
page | No | Integer | Define which page is displayed. |
page_size | No | Integer | Define how many records per page. |
sort_by | No | String | Define the sorting field. Valid value:
|
order_by | No | String | Define the display order. Valid value:
|
search_value | No | String | Search keyword. |
Response parameters
Parameter | Type | Description |
---|---|---|
errcode | Integer | Returned error code.
Note: You can check the error code and
error message in Error Code and Error Message.
|
errmsg | String | Returned message.
|
total_number | Integer | The total number of PIN list. |
data | Array <PINList_Info> | The information of each PIN list. |
- PINList_Info
-
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
: No1
: Yes
Examples
Request example
GET /openapi/v1.0/pin_list/search?search_value=local&access_token=ojPrvnfzPdwc8OCcRmhG16gEHuZcwFco HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
Response example
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"total_number": 1,
"data": [
{
"id": 13,
"name": "local_calls",
"pin_list": "2283,3301",
"enb_record_cdr": 0
}
]
}