创建机器人

最近更新时间:2024-07-09 18:05:51

我的收藏

功能说明

机器人在许多业务场景中都有广泛的应用。在办公场景,用户可以通过机器人辅助完成工作纪要、文案编写等需求;在社交领域可以使用机器人提供新闻和趣事,提升群内的活跃度,增加用户粘性;在客服场景,机器人与AI的结合可以更好的为客户提供咨询和支持等。
本接口用于创建一个机器人账号。机器人账号是一种特殊的用户账号,它也通过 UserID 来唯一标识(但是其 UserID 必须以@RBT#开头),具有昵称、头像、签名等基本属性。作为一种限制性的账号,机器人只有普通账号的部分功能,如收发消息,加入群组等,但同时机器人账号也可以实现一些普通账号不具有的特性与功能,例如 支持流式消息发消息不检验好友关系加群无上限、单聊机器人消息回调群内@机器人之后回调 等。
注意:
同一个机器人账号 UserID 重复创建仅会创建1个机器人。
每个 IM 账号只能创建最多20个机器人账号。
如果要类似实现 FAQ 智能问答、闲聊、数据运营看板等功能,可以使用智能机器人

接口调用说明

请求 URL 示例

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

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名:
中国:console.tim.qq.com
新加坡:adminapisgp.im.qcloud.com
首尔: adminapikr.im.qcloud.com
法兰克福:adminapiger.im.qcloud.com
硅谷:adminapiusa.im.qcloud.com
雅加达:adminapiidn.im.qcloud.com
v4/openim_robot_http_svc/create_robot
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

{
"UserID": "@RBT#001",
"Nick": "Jarvis",
"FaceUrl": "www.example.com/head.jpg",
"SelfSignature": "hello, world"
}

请求包字段说明

字段
类型
属性
说明
UserID
String
必填
机器人用户名,长度不超过32字节,必须以@RBT#开头
Nick
String
选填
机器人昵称
FaceUrl
String
选填
机器人头像 URL
SelfSignature
String
选填
机器人签名,不超过500字节

应答包体示例

{
"ActionStatus":"OK",
"ErrorInfo":"",
"ErrorCode":0
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果:
OK:表示处理成功
FAIL:表示失败
ErrorCode
Integer
错误码:
0:表示成功
非0:表示失败
ErrorInfo
String
错误信息

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。公共错误码(60000到79999)参见 错误码 文档。本 API 私有错误码如下:
错误码
含义说明
10002
内部错误,请重试
10004
参数非法,请检查必填字段是否填充,或者字段的填充是否满足协议要求
10008
非法请求,需要 App 管理员权限、创建的机器人已达上限等
40006
设置资料时服务器内部错误,请稍后重试
40601
资料字段的 Value 长度超过500字节
70398
账号数超限。如需创建多于100个账号,请将应用升级为专业版,具体操作指引请参见 购买指引

接口调试工具

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

参考