跳到主要内容

更新机器人

更新机器人的信息。

请求方法

POST: https://数据中心域名/v3/bot/create.json

频率限制: 每秒钟限 100 次

签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名

正文参数

HTTP 请求正文数据格式为 application/json,支持以下 HTTP 请求参数:

参数类型必传说明
userIdString机器人的唯一 ID,长度限制为 64 个字符。
nameString机器人的昵称,长度限制为 128 个字符。
typeString指定机器人的类型,以便对机器人进行分类。长度限制为 128 个字符。
profileUrlString指定机器人头像的 URL。长度限制为 256 个字符。
metadataMap<String, Strinng>自定义元数据键值对,可用于存储业务相关附加信息。格式为键值对集合,其中键(key)为1-32字符的字符串,值(value)为1-128字符的字符串,最多支持16对。

请求示例

HTTP
POST  /v3/bot/update.json HTTP/1.1
Host: api.rong-api.com
App-Key: e0x9wycxx2qdq
Nonce: 83682
Timestamp: 1726627371000
Signature: 81be659c74fccb5be993d553c51f5e26c13e6825
Content-Type: application/json

{
"userId": "bot-01002",
"name": "小助手",
"type": "AI",
"profileUrl": "https://example.com/profile.png",
"metadata": {
"creator": "运营团队",
"version": 1
}
}

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象:

返回值返回类型说明
codeInt返回码。 200 表示处理成功。

返回结果示例

HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX

{"code":200}

错误码

详见错误码说明