文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>即时通信 IM>智能客服（Desk）>服务端 API>REST API>机器人管理相关接口>拉取机器人列表

拉取机器人列表

最近更新时间：2026-07-01 15:55:36

我的收藏

本页目录：

接口调用说明

App 管理员主动调用 REST API 接口拉取机器人列表。

请求 URL 示例

https://xxxxxx/v4/openim_console_http_svc/desk_get_robot_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
v4/openim_console_http_svc/desk_get_robot_list
请求接口。
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID。
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员。
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig。
random
请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype
请求格式固定值为 json。

最高调用频率

5次/秒。

请求包示例

{}

请求包字段说明

无需额外请求字段。

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "RobotList": [
        {
            "RobotId": "@RBT#DeskDefaultRobot",
            "Nick": "test-robot",
            "CreateTime": "2026-02-25 16:29:03",
            "IsDefault": 1
        },
        {
            "RobotId": "@RBT#1747124092eniezohf",
            "Nick": "test-robot-2",
            "CreateTime": "2026-03-10 10:15:30",
            "IsDefault": 0
        }
    ]
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果，OK 表示处理成功，FAIL 表示失败。
ErrorCode
Integer
错误码，0表示成功，非0表示失败。
ErrorInfo
String
错误信息。
RobotList
Array
机器人列表。
RobotList 中每个元素的字段说明：
字段
类型
说明
RobotId
String
机器人的 RobotId。
Nick
String
机器人昵称。
CreateTime
String
机器人创建时间，格式为 YYYY-MM-DD HH:MM:SS。
IsDefault
Integer
是否为默认机器人。1 表示默认机器人，0 表示非默认机器人。

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
描述
-1
系统错误，请联系我们处理。
-7
参数解析失败，请检查请求包是否符合 JSON 规范或者请求参数符合要求。
-14
超过该接口允许的最大频率限制。
-20
请求需要 App 管理员权限。
-50040
未开通智能客服。
-50059
智能客服版本过期。

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考

联系我们

如果您在接入过程中有任何疑问，请用微信或企业微信扫码加入智能客服交流群进行咨询。

中国站