GetContactWhiteList - 获取外呼白名单列表_智能外呼机器人(Outbound Bot)-阿里云帮助中心

获取全局外呼策略白名单。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
outboundbot:GetContactWhiteList	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	页号	1
PageSize	integer	否	每页显示的条数	10
CountTotalRow	boolean	否	是否需要总条数	true
InstanceId	string	是	实例 ID	2a830781-324e-4568-ae96-309f93090fe1

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 状态码	200
Code	string	接口状态码	OK
Message	string	接口提示消息	Success
RequestId	string	请求 id	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	是否成功	true
ContactWhitelistList	object	联系人列表
PageSize	integer	每页个数	10
PageNumber	integer	页号	1
TotalCount	integer	总计个数	100
List	array<object>	联系人列表	{}
ContactWhitelistList	object
CreationTime	long	创建时间	1640174411848
Remark	string	备注	xxxx
PhoneNumber	string	手机号码	13959999999
Operator	string	操作者	xxx
ContactWhiteListId	string	白名单 ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
InstanceId	string	实例 ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Name	string	姓名	张三
Creator	string	创建者	测试123

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "ContactWhitelistList": {
    "PageSize": 10,
    "PageNumber": 1,
    "TotalCount": 100,
    "List": [
      {
        "CreationTime": 1640174411848,
        "Remark": "xxxx",
        "PhoneNumber": 13959999999,
        "Operator": "xxx",
        "ContactWhiteListId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
        "InstanceId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
        "Name": "张三",
        "Creator": "测试123"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.	内部错误。建议重试，如果多次重试报错请提交工单。

访问错误中心查看更多错误码。