文档

ListInstance - 机器人-列表

更新时间:

查询机器人列表。

调试

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

授权信息

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

请求参数

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

分页-第几页,默认 1

1
PageSizelong

分页-页面大小,默认 10

10
RobotTypestring

按机器人类型筛选

枚举值:
  • scenario_callout外呼机器人
  • scenario_im在线文本机器人
  • scenario_ivr导航机器人
scenario_im
Namestring

按机器人名称模糊搜索

售前客服
AgentKeystring

业务空间 key,不设置则访问默认业务空间,key 值在主账号业务管理页面获取

ac627989eb4f8a98ed05fd098bbae5_p_beebot_public

返回参数

名称类型描述示例值
object
Instancesobject []

机器人列表信息

InstanceIdstring

机器人唯一标识

chatbot-cn-mp90s2lrk00050
Namestring

机器人名称

智能客服-小C
Introductionstring

机器人备注

用于C端问答的机器人
LanguageCodestring

机器人服务的语言,如 zh-cn、en-us,参考 http://www.lingoes.net/zh/translator/langcode.htm

zh-cn
RobotTypestring

机器人类型

枚举值:
  • scenario_callout外呼机器人
  • scenario_im在线文本机器人
  • scenario_ivr导航机器人
scenario_im
Avatarstring

机器人头像的 URL

/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png
CreateTimestring

机器人创建的 UTC 时间

2021-08-12T16:00:01Z
TotalCountlong

总条数

23
PageSizelong

分页-页面大小

5
PageNumberlong

分页-第几页

1
RequestIdstring

请求 ID

92B81548-42B9-4B34-924B-4E778AEB412B

示例

响应报文:

 {
  "PageNumber": 1,
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "787B6D28-A81E-486F-BC8C-64ADED337B25",
  "Instances":[
      {
          "InstanceId":"chatbot-cn-xxxxx",
          "Avatar":"/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png",
          "LanguageCode":"zh-cn",
          "RobotType":"scenario_im",
          "Name":"智能客服-小 C",
          "Introduction":"用于 C 端问答的机器人",
          "CreateTime":"2021-08-12T16:00:01Z"
      }
    ]
}

示例

正常返回示例

JSON格式

{
  "Instances": [
    {
      "InstanceId": "chatbot-cn-mp90s2lrk00050",
      "Name": "智能客服-小C",
      "Introduction": "用于C端问答的机器人",
      "LanguageCode": "zh-cn",
      "RobotType": "scenario_im",
      "Avatar": "/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png",
      "CreateTime": "2021-08-12T16:00:01Z"
    }
  ],
  "TotalCount": 23,
  "PageSize": 5,
  "PageNumber": 1,
  "RequestId": "92B81548-42B9-4B34-924B-4E778AEB412B"
}

错误码

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

  • 本页导读 (0)
文档反馈