获取机器人列表接口
更新时间:2024-04-26
概述
调用接口,可获取租户下所有的已发布的外呼机器人
URL
https://aiob-open.baidu.com/api/v1/robot/list
https://aicc.bce.baidu.com/api/v1/robot/list(即将下线)
HTTP Method
GET
请求参数
HEADER
参数名称 | 是否必须 | 说明 | 示例 |
---|---|---|---|
Authorization | 是 | 参考「生成认证Token」文档 | cc-api-auth-v1/5b050c050f5a4e74b8c20bf512e39c1d/2021-04-13T08:05:43Z/1800000/host;x-bce-date/746ed9ad706c379f31bafc292e3c720797e39bb7f08ce5f641d657e14e42dd33 |
PARAM
参数名称 | 是否必须 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
robotName | 否 | string | 机器人名称 | “机器人名称” |
pn | 否 | int | 页码,非必填,默认为1 | 2 |
ps | 否 | int | 每页显示号码个数,非必填,默认20 | 20 |
响应参数
字段名称 | 数据类型 | 说明 | 示例 |
---|---|---|---|
robotId | string | 机器人ID | "650d4978-d288-4fbd-bbf9-22ab4c032fe1" |
robotName | string | 机器人名称 | "机器人名称" |
callType | int | 机器人呼叫类型,1-呼入,3-呼出 | 3 |
industryId | string | 机器人行业id ,如下所示 | “4f7aaba5-8e39-498a-8d50-3d996c4ab0e2” |
createUserId | long | 创建人id | 1633 |
publishState | int | 发布状态,1-未发布,2-发布中,3-发布成功,4-发布失败 | 3 |
publishUserId |
long | 发布人id | 1633 |
请求示例
https://aiob-open.baidu.com/api/v1/robot/list?robotName=test&pn=1
返回示例
{
"code": 200,
"msg": "OK",
"data": {
"pn": null,
"ps": null,
"orderBy": null,
"order": null,
"total": null,
"list": [
{
"robotId": "650d4978-d288-4fbd-bbf9-22ab4c032fe1",
"robotName": "机器人B",
"callType": 3,
"industryId": "4f7aaba5-8e39-498a-8d50-3d996c4ab0e2",
"createUserId": 1633,
"publishState": 3,
"publishUserId": 1633
},
{
"robotId": "2d85196d-b712-4ec7-8fa4-2d80233902c2",
"robotName": "测试paas",
"callType": 3,
"industryId": "4f7aaba5-8e39-498a-8d50-3d996c4ab0e2",
"createUserId": 1633,
"publishState": 3,
"publishUserId": 1633
},
{
"robotId": "2f1fd0ca-2d2c-40bd-8d34-e5e8ce6a4cb4",
"robotName": "花木兰",
"callType": 3,
"industryId": "4f7aaba5-8e39-498a-8d50-3d996c4ab0e2",
"createUserId": 1633,
"publishState": 3,
"publishUserId": 1633
},
{
"robotId": "b385836a-9320-4f0d-af82-ac7440a46d92",
"robotName": "wytest",
"callType": 3,
"industryId": "4f7aaba5-8e39-498a-8d50-3d996c4ab0e2",
"createUserId": 1633,
"publishState": 3,
"publishUserId": 1633
}
]
}
}
其他字段说明
枚举值说明:
callType
呼入:1
呼出:3
publishState
未发布:1
发布中:2
发布成功:3
发布失败:4
industryId
通用:4f7aaba5-8e39-498a-8d50-3d996c4ab0e2
银行:ed0165dc-d0eb-46d4-adf7-4c26b05db167
保险:2e3c886e-3dc7-4b10-b3f7-62746a017995
电信运营商:b68abfa2-c674-4988-8bc5-5b52615be374
能源:4709e482-dda6-4011-8329-d875e6edd902
教育:70457676-d79a-4b02-b744-7e2485356fc5
通信:0b0b7dc4-7cfc-4d9e-8c4a-aba2482ca14d
电商:4cf99f6d-f33b-4f99-930c-a894e7d81d9a
消费金融:fae57be2-6d80-4cf9-b69e-825a9507ab29
航空:05dc9f87-5e4d-408b-a75d-2894eac69f14