搜索特定 PIN 码列表

搜索特定 PIN 码列表。

请求 URL

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

请求参数

表 1.
参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。
sort_by 否 String 定义排序字段。
取值范围：
  • id
  • name
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序
  • desc：降序
search_value 否 String 搜索关键字。

响应参数

表 2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 搜索到的 PIN 码列表总数。
data Array <PINList_Info> 每个 PIN 码列表的信息。
PINList_Info
表 3.
参数 类型 说明
id Integer PIN 码列表的唯一 ID。
name String PIN 码列表名称。
pin_list String PIN 码。
enb_record_cdr Integer 使用 PIN 码后是否记录在 CDR 中。
  • 0：否
  • 1：是

示例

请求示例

GET /openapi/v1.0/pin_list/search?search_value=local&access_token=ojPrvnfzPdwc8OCcRmhG16gEHuZcwFco HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
响应示例
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
        }
    ]
}