查询多个禁止号码规则的信息
查询多个黑名单号码规则的具体信息。
请求 URL
GET {base_url}/{api_path}/block_numbers/query?access_token={access_token}
请求参数
参数 | 是否必填 | 类型 | 说明 |
---|---|---|---|
ids | 是 | String | 黑名单规则的唯一 ID。 注:
|
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | Integer | 返回错误码。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
|
errmsg | String | 返回信息。
|
data | Array <BlockedNumbers_Info> | 每个黑名单号码规则的信息。 |
- BlockedNumbers_Info
-
表 3. 参数 类型 说明 id Integer 黑名单规则的唯一 ID。 name String 黑名单规则的名称。 limit_type String 适用于黑名单规则的通信类型。 number_list String 被系统禁止的号码。
示例
请求示例
GET /openapi/v1.0/block_numbers/query?access_token=OPmgiTyngN4XJrvYAYepnmVJdggXbOjF&ids=2,3 HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com
响应示例
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"data": [
{
"id": 2,
"name": "Service Promotion",
"limit_type": "inbound",
"number_list": "010059292"
},
{
"id": 3,
"name": "Fraud Calls",
"limit_type": "inbound",
"number_list": "82469079"
}
]
}