跳到主要内容

创建机器人

在应用中创建一个新的机器人实例。支持通过 Webhook 方式或集成 Dify 等第三方平台，开发者可根据具体业务场景选择合适的集成方式，实现消息接收、事件回调和智能应答等能力。该接口旨在帮助开发者快速构建面向对话的自动化服务。

提示

每个应用最多可创建 10 个机器人。

请求方法​

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, String>否自定义元数据键值对，可用于存储业务相关附加信息。格式为键值对集合，其中键(key)为1-32字符的字符串，值(value)为1-128字符的字符串，最多支持16对。
integrationsArray<Object>是集成平台配置列表，可配置多个平台（如 webhook、dify）。
integrations[].enabledBoolean否是否启用该集成项。
integrations[].typeString是回调类型，可选值详见 回调类型列表。
integrations[].callbackUrlString是该平台的回调地址。用于接收用户消息或事件通知。
integrations[].objectNamesArray<String>否指定要监听的消息类型，可选值详见 消息类型列表。
integrations[].eventsArray<String>否指定触发事件类型，可选值详见 事件类型列表。
integrations[].streamBoolean否是否启用流式响应（适用于如 dify 等平台）。默认 true。
integrations[].handleResponseBoolean否是否处理第三方返回结果（适用于如 dify 等平台），默认 true。
integrations[].auth.apiKeyString否第三方平台的认证信息，通常是 API Key（如接入 Dify 所需）。仅当该平台需要认证时填写。
注意事项：
  • Dify 类型集成仅支持接收文本消息，消息类型必须为 RC:TxtMsg。
  • 字段 integrations[].objectNames 对于 Dify 类型，默认已包含 RC:TxtMsg，无需额外配置。
  • Dify 类型的回调地址（callbackUrl）格式为： 
    codeBlockStandalone_MEMbthin-scrollbartxt
    https://api.dify.ai/v1 
    codeBlockStandalone_MEMbthin-scrollbar

请求示例​

HTTP
POST  /v3/bot/create.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",
    "integrations": [
        {
            "enabled": false,
            "type": "webhook",
            "callbackUrl": "https://yourserver.com/callback",
            "objectNames":["RC:TxtMsg"],
            "events":["message:private"]
        },
        {
            "enabled": true,
            "type": "dify_chat",
            "callbackUrl": "https://api.dify.ai/v1",
            "stream": true,
            "handleResponse":true,
            "auth": {
                "apiKey": "app-91hoxxhHPni4dj9FycAdYeE0"
            }
        }
    ],
    "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}

错误码​

详见错误码说明

最后于 更新