獲取指定實例下指定搜索條件過濾后的禁止外呼號碼列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 實例 ID。 | ccc-test |
| SearchPattern | string | 是 | 根據電話號碼或備注進行模糊匹配，非必填，默認為空，為空表示不過濾。 | RemarkA |
| PageNumber | integer | 是 | 分頁序號，范圍 1-100。 | 1 |
| PageSize | integer | 是 | 分頁大小，范圍 1-100。 | 10 |
| Scope | string | 否 | 應用范圍，包括 SYSTEM 和 INSTANCE，分別對應系統級禁止外呼和客戶自定義禁止外呼，SYSTEM 是關聯實例所屬的阿里云主賬號的，INSTANCE 只和當前實例關聯，非必填，默認值 INSTANCE。 枚舉值：
| INSTANCE |
返回參數
示例
正常返回示例
JSON格式
{
"Code": "OK",
"HttpStatusCode": 200,
"Message": "無",
"RequestId": "BA03159C-E808-4FF1-B27E-A61B6E888D7F",
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 1,
"List": [
{
"Number": "1900000****",
"Scope": "INSTANCE",
"Remark": "測試",
"CreateTime": 1626962425000,
"Creator": "agent",
"CreatedTime": 1631440860000
}
]
},
"Params": [
"無"
]
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | Parameter.Blank | The parameter %s must not be null or empty. | 該參數不能為null值。 |
| 400 | Parameter.Enumeration | The parameter %s must be one of the value of enumeration %s. | 該參數必須為系統限定的枚舉值之一。 |
| 400 | Parameter.Empty | The parameter %s may not be null or empty. | 該參數不能為null值或為空字符串。 |
| 404 | NotExists.InstanceId | The specified instance %s does not exist. | 指定的呼叫中心實例不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2022-02-24 | 新增 OpenAPI | 查看變更詳情 |