ListChatbotInstances - 查询外呼实例列表

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
PageNumberinteger

页号

1
PageSizeinteger

个数

10

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

http 状态码

200
Codestring

响应码

OK
Messagestring

接口提示消息

Success
RequestIdstring

请求 id

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Successboolean

是否成功

true
Botsarray<object>

机器⼈列表信息

object

机器⼈列表信息

Introductionstring

机器⼈备注

这是直播的描述
Avatarstring

头像 url

https://ccrm.wengine.cn/ccrm/system/common/fileDownload/noToken?fileId=975cdeaa064846e3b6004abd9ba1d7c8
TimeZonestring

机器⼈的时区,参考《公共-时区码》

Asia/Shanghai
CreateTimestring

创建时间

2022-01-18T02:36:00Z
LanguageCodestring

机器⼈服务的语⾔,如 zh-cn、 en-us

zh-cn
InstanceIdstring

实例 id

e874fcf0-d2f4-4e62-9377-b6f35fe55210
Namestring

机器人名字

智能回访2
PageSizelong

个数

10
PageNumberlong

页号

5
TotalCountlong

总计个数

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错误码错误信息描述
404NotExist.InstanceThe specified Instance does not exist.指定的实例不存在。
500InternalErrorAn error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.内部错误。建议重试,如果多次重试报错请提交工单。

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

变更历史

变更时间变更内容概要操作
2024-04-25OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情