查询允许号码列表
查询白名单列表。
请求 URL
GET {base_url}/{api_path}/allow_numbers/list?access_token={access_token}
请求参数
参数 | 是否必填 | 类型 | 说明 |
---|---|---|---|
page | 否 | Integer | 定义显示第几个页面。 |
page_size | 否 | Integer | 定义每页显示几项查询结果。 |
sort_by | 否 | String | 定义排序字段。 取值范围:
|
order_by | 否 | String | 定义显示顺序。 取值范围:
|
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | Integer | 返回错误码。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
|
errmsg | String | 返回信息。
|
total_number | Integer | 白名单规则的总数量。 |
data | Array <Allowlist_Info> | 白名单规则的信息。 |
- Allowlist_Info
-
表 3. 参数 类型 说明 id Integer 白名单规则的唯一 ID。 name String 白名单规则的名称。 limit_type String 适用于白名单规则的通信类型。 number_list String 列表中的号码将被系统允许呼叫。
示例
请求示例
GET /openapi/v1.0/allow_numbers/list?access_token=DfwoCmAqPuexIOQH1NY7j8l8U391niHD HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com
响应示例
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"total_number": 2,
"data": [
{
"id": 2,
"name": "Test List",
"limit_type": "both",
"number_list": "9011."
},
{
"id": 1,
"name": "Dependable Calls",
"limit_type": "both",
"number_list": "12355"
}
]
}