通过ListChatbotInstances查询机器人实例列表-智能外呼机器人-阿里云-伶鹊(Cloud Contact Center)-阿里云帮助中心

查询云小蜜机器人公有云版本实例列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

outboundbot:ListChatbotInstances

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	是	页号	1
PageSize	integer	是	个数说明该参数的值需小于等于 50	10
AgentKey	string	否	机器人业务空间访问 Key 说明 ListChatbotAgents 获取，默认不填，则查询所有业务空间的机器人。	9137ab9c27044921860030adf8590ec4_p_outbound_public

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 状态码	200
Code	string	响应码	OK
Message	string	接口提示消息	Success
RequestId	string	请求 ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	是否成功	true
Bots	array<object>	机器⼈列表信息
	object	机器⼈列表信息
Introduction	string	机器⼈备注	这是直播的描述
Avatar	string	头像 URL	https://ccrm.wengine.cn/ccrm/system/common/fileDownload/noToken?fileId=975cdeaa064846e3b6004abd9ba1d7c8
TimeZone	string	机器⼈的时区，参考《公共-时区码》	Asia/Shanghai
CreateTime	string	创建时间。使用 UTC 时间，格式为 YYYY-MM-DDTHH:mm:ssZ。	2022-01-18T02:36:00Z
LanguageCode	string	机器⼈服务的语⾔，如 zh-cn、 en-us	zh-cn
InstanceId	string	实例 ID	e874fcf0-d2f4-4e62-9377-b6f35fe55210
Name	string	机器人名字	智能回访2
PageSize	integer	个数	10
PageNumber	integer	页号	5
TotalCount	integer	总计个数	100

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Bots": [
    {
      "Introduction": "这是直播的描述",
      "Avatar": "https://ccrm.wengine.cn/ccrm/system/common/fileDownload/noToken?fileId=975cdeaa064846e3b6004abd9ba1d7c8",
      "TimeZone": "Asia/Shanghai",
      "CreateTime": "2022-01-18T02:36:00Z",
      "LanguageCode": "zh-cn",
      "InstanceId": "e874fcf0-d2f4-4e62-9377-b6f35fe55210",
      "Name": "智能回访2"
    }
  ],
  "PageSize": 10,
  "PageNumber": 5,
  "TotalCount": 100
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.	内部错误。建议重试，如果多次重试报错请提交工单。
404	NotExist.Instance	The specified Instance does not exist.	指定的实例不存在。

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

变更历史

更多信息，参考变更详情。