跳到主要内容

添加机器人回调配置

为已存在的机器人实例添加第三方集成平台配置,支持灵活接入 webhook、dify 等多种平台,满足不同应用场景需求。

请求方法

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

频率限制: 每秒钟限 100 次

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

正文参数

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

参数类型必传说明
userIdString机器人的唯一 ID,长度限制为 64 个字符。
enabledBoolean是否启用。
typeString回调类型,可选值详见 回调类型列表
callbackUrlString该平台的回调地址。用于接收用户消息或事件通知。
objectNamesArray<String>指定要监听的消息类型,可选值详见 消息类型列表
eventsArray<String>指定触发事件类型,可选值详见 事件类型列表。。
streamBoolean是否启用流式响应(适用于如 dify 等平台)。默认 true
handleResponseBoolean是否处理第三方返回结果(适用于如 dify 等平台),默认 true
auth.apiKeyString第三方平台的认证信息,通常是 API Key(如接入 Dify 所需)。仅当该平台需要认证时填写。

请求示例

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",
"enabled": true,
"type": "dify_chat",
"callbackUrl": "https://api.dify.ai/v1",
"stream": true,
"handleResponse": true,
"auth": {
"apiKey": "app-91hoxxhHPni4dj9FycAdYeE0"
}
}

返回结果

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

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

返回结果示例

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

{"code":200}

错误码

详见错误码说明