机器人 API

机器人模块提供机器人账号的创建、查询、列表、更新与删除;运行时对话能力依赖外部模型。

模块概览​

项目值
接口数量8
幂等接口2
路径前缀/im/v2
请求方法POST(JSON 请求体)
鉴权方式App-Key / Nonce / Timestamp / Signature(见 鉴权与签名)
响应信封{ code, msg?, data?, requestId? }

接口列表​

接口方法路径说明幂等
创建机器人账号POST/im/v2/bot/create创建机器人账号(用于自动回复/托管;运行时对话能力需外部模型)。否
获取指定机器人POST/im/v2/bot/get获取指定机器人。否
列出机器人POST/im/v2/bot/list列出机器人(分页)。否
更新机器人资料POST/im/v2/bot/update更新机器人资料。是
删除机器人POST/im/v2/bot/delete删除机器人。否
为已存在的机器人登记 Webhook 回调集成POST/im/v2/v3/bot/integration/create为已存在的机器人(bot.create 产出)登记 Webhook 回调集成:每个机器人一份配置、应用内 <=10 份;events 取 bot.message.private / bot.message.group / bot.message.chatroom / bot.chatroom.user.join。secret 缺省自动生成;回调签名与既有回调一致。覆盖融云 /v3/bot/integration/create.json。否
更新机器人 Webhook 集成POST/im/v2/v3/bot/integration/update更新机器人 Webhook 集成(name / webhookUrl / secret / events / enabled 均可选,只覆盖传入字段)。覆盖融云 /v3/bot/integration/update.json。是
删除机器人 Webhook 集成配置POST/im/v2/v3/bot/integration/delete删除机器人 Webhook 集成配置;配置不存在返回 1001(不静默成功)。覆盖融云 /v3/bot/integration/delete.json。否

接口约定​

  • 完整请求地址 = 部署域名 + /im/v2 + 接口路径;所有接口使用 POST。
  • 请求头必须携带 App-Key / Nonce / Timestamp / Signature;签名规则见鉴权与签名。
  • 响应统一为 { code, msg?, data?, requestId? };code = 0 表示成功。
  • 列表类接口使用 limit 分页,单页上限见限频与限制。

相关说明​