更新机器人回调配置
修改已存在机器人的回调配置信息,实现对 webhook、dify 等第三方平台的灵活调整和管理。
请求方法
POST: https://数据中心域名/v3/bot/integration/update.json
频率限制: 每秒钟限 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/json
,支持以下 HTTP 请求参数 :
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
userId | String | 是 | 机器人的唯一 ID,长度限制为 64 个字符。 |
enabled | Boolean | 否 | 是否启用。 |
type | String | 是 | 回调类型,可选值详见 回调类型列表。 |
callbackUrl | String | 否 | 该平台的回调地址。用于接收用户消息或事件通知。 |
objectNames | Array<String> | 否 | 指定要监听的消息类型,可选值详见 消息类型列表。 |
events | Array<String> | 否 | 指定触发事件类型,可选值详见 事件类型列表。 |
stream | Boolean | 否 | 是否启用流式响应(适用于如 dify 等平台)。默认 true 。 |
handleResponse | Boolean | 否 | 是否处理第三方返回结果(适用于如 dify 等平台),默认 true 。 |
auth.apiKey | String | 否 | 第三方平台的认证信息,通常是 API Key(如接入 Dify 所需)。仅当该平台需要认证时填写。 |
请求示例
HTTP
POST /v3/bot/integration/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",
"enabled": true,
"type": "dify_chat",
"callbackUrl": "https://api.dify.ai/v1",
"stream": true,
"handleResponse": true,
"auth": {
"apiKey": "app-91hoxxhHPni4dj9FycAdYeE0"
}
}
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Int | 返回码。 200 表示处理成功。 |
返回结果示例
HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX
{"code":200}