查询机器人
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
cms:ListAlertRobots |
list |
*AlertRobot
|
无 | 无 |
请求语法
GET /robots HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| pageSize |
integer |
否 |
每页大小。默认 100 |
10 |
| pageNumber |
integer |
否 |
页面。默认为 1 |
1 |
| robotIds |
array |
否 |
机器人 ID。 |
|
|
string |
否 |
机器人 ID。 |
test |
|
| name |
string |
否 |
机器人名称。支持前缀模糊搜索 |
test |
| types |
array |
否 |
机器人类型。 |
|
|
string |
否 |
机器人类型。 |
DING |
|
| workspace |
string |
否 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
响应内容结构 |
||
| pageNumber |
integer |
页码。 |
1 |
| pageSize |
integer |
分页大小。 |
20 |
| requestId |
string |
请求 ID |
8FDE2569-626B-5176-9844-28877A***** |
| robots |
array<object> |
机器人 ID。 |
|
|
object |
机器人 ID。 |
||
| lang |
string |
语言。 |
zh_CN |
| name |
string |
机器人名称。 |
test |
| robotId |
string |
机器人唯一 ID。 |
test |
| type |
string |
机器人类型。 |
DING |
| url |
string |
机器人 webhook。 |
https://oapi.dingtalk.com/robot/send?access_token=******* |
| workspace |
string |
||
| digitalEmployeeName |
string |
||
| robotSignKey |
string |
||
| total |
integer |
总记录数 |
3 |
示例
正常返回示例
JSON格式
{
"pageNumber": 1,
"pageSize": 20,
"requestId": "8FDE2569-626B-5176-9844-28877A*****",
"robots": [
{
"lang": "zh_CN",
"name": "test",
"robotId": "test",
"type": "DING",
"url": "https://oapi.dingtalk.com/robot/send?access_token=*******",
"workspace": "",
"digitalEmployeeName": "",
"robotSignKey": ""
}
],
"total": 3
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | %s is missing or invalid. | 参数%s缺失或不合法。 |
| 500 | InternalUnknownError | The request processing has failed due to some unknown error. | 服务运行错误。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。