查询机器人列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PageNumber |
integer |
否 |
分页-第几页,默认 1 |
1 |
| PageSize |
integer |
否 |
分页-页面大小,默认 10 |
10 |
| RobotType |
string |
否 |
按机器人类型筛选 枚举值:
|
scenario_im |
| Name |
string |
否 |
按机器人名称模糊搜索 |
售前客服 |
| AgentKey |
string |
否 |
业务空间 key,不设置则访问默认业务空间,key 值在主账号业务管理页面获取 |
ac627989eb4f8a98ed05fd098bbae5_p_beebot_public |
| Sandbox |
boolean |
否 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Instances |
array<object> |
机器人列表信息 |
|
|
object |
机器人信息 |
||
| InstanceId |
string |
机器人唯一标识 |
chatbot-cn-mp90s2lrk00050 |
| Name |
string |
机器人名称 |
智能客服-小C |
| Introduction |
string |
机器人备注 |
用于C端问答的机器人 |
| LanguageCode |
string |
机器人服务的语言,如 zh-cn、en-us,参考 http://www.lingoes.net/zh/translator/langcode.htm |
zh-cn |
| RobotType |
string |
机器人类型 枚举值:
|
scenario_im |
| Avatar |
string |
机器人头像的 URL |
/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png |
| CreateTime |
string |
机器人创建的 UTC 时间 |
2021-08-12T16:00:01Z |
| TotalCount |
integer |
总条数 |
23 |
| PageSize |
integer |
分页-页面大小 |
5 |
| PageNumber |
integer |
分页-第几页 |
1 |
| RequestId |
string |
请求 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"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。