自定义机器人接口规范
更新时间：2025-12-09
概述
使用自有对话引擎，可以按此规范提供一个开放接口，在平台创建自定义机器人配置接口地址和token，通过机器人对话会触发此接口的调用。
请求参数
Header参数
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Content-Type | string | 是 | 内容类型，固定值：application/json |
| token | string | 是 | API KEY |
| Authorization | string | 是 | Bearer token |
Body参数
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| queryText | string | 否 | 用户问题，请求的问题，比如示例中的：帮我写一首爱情的诗 |
| sessionId | string | 否 | 会话id，首轮可以为空（如果首轮传了，后续需要使用首轮传的。），首轮会返回sessionId,后续对话需要使用返回的sessionId。 |
| variables | object | 否 | 变量，Map格式，key 是变量名称，value是变量值。对话中使用的变量，如果传了会覆盖当前中对话中已有的变量值。 |
请求示例
JSON
1curl --location 'https://xxx/stream/query'
2--header 'token: xxxx'
3--header 'Authorization: Bearer token'
4--header 'Content-Type: application/json'
5--data '{
6 "queryText": "你是谁啊",
7 "sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d",
8 "variables": {
9 "homeAddress": "chengdu"
10 }
11}'响应参数
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| sessionId | string | 是 | 会话ID，用于标识会话的唯一ID |
| queryId | string | 是 | 查询ID，用于标识本次对话的唯一ID |
| answer | array | 是 | 回答列表，包含各个回答块的数组 |
| → chunkId | integer | 是 | 流式chunkId |
| → status | string | 是 | 流式返回数据状态，running(进行中)，done(完成) |
| → reply | object | 否 | 回复，包含回复相关详细信息的对象 |
| → → type | integer | 是 | 回复类型，1(文本) |
| → → text | string | 是 | 回复文本 |
| → → audioURL | string | 否 | 回复文本录音地址 |
| → → replySource | string | 是 | 回复来源，FAQ(问答)、RAG(文档问答)、CHITCHAT(闲聊)、TEXT_REPLY(文本回复)、LARGE_MODEL_REPLY(大模型回复) |
响应示例
JSON
1{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 15,"status": "done","reply": {"type": 1,"text": "","audioUrl": null,"replySource": "CHITCHAT"}}]}
2{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 14,"status": "running","reply": {"type": 1,"text": "~","audioUrl": null,"replySource": "CHITCHAT"}}]}
3{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 13,"status": "running","reply": {"type": 1,"text": "尽管说","audioUrl": null,"replySource": "CHITCHAT"}}]}
4{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 12,"status": "running","reply": {"type": 1,"text": "有啥事儿","audioUrl": null,"replySource": "CHITCHAT"}}]}
5{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 11,"status": "running","reply": {"type": 1,"text": "，","audioUrl": null,"replySource": "CHITCHAT"}}]}
6{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 10,"status": "running","reply": {"type": 1,"text": "帮你解决问题的","audioUrl": null,"replySource": "CHITCHAT"}}]}
7{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 9,"status": "running","reply": {"type": 1,"text": "、","audioUrl": null,"replySource": "CHITCHAT"}}]}
8{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 8,"status": "running","reply": {"type": 1,"text": "聊天","audioUrl": null,"replySource": "CHITCHAT"}}]}
9{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 7,"status": "running","reply": {"type": 1,"text": "来陪你","audioUrl": null,"replySource": "CHITCHAT"}}]}
10{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 6,"status": "running","reply": {"type": 1,"text": "，专门","audioUrl": null,"replySource": "CHITCHAT"}}]}
11{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 5,"status": "running","reply": {"type": 1,"text": "的小助手","audioUrl": null,"replySource": "CHITCHAT"}}]}
12{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 4,"status": "running","reply": {"type": 1,"text": "中心","audioUrl": null,"replySource": "CHITCHAT"}}]}
13{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 3,"status": "running","reply": {"type": 1,"text": "坐席","audioUrl": null,"replySource": "CHITCHAT"}}]}
14{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 2,"status": "running","reply": {"type": 1,"text": "，是","audioUrl": null,"replySource": "CHITCHAT"}}]}
15{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 1,"status": "running","reply": {"type": 1,"text": "呀","audioUrl": null,"replySource": "CHITCHAT"}}]}
16{"sessionId": "3_f7de7ec487694bc7bf2f64cf309cbd8d","queryId": "7c0cd473-aba6-44e1-b84c-04890415cb9c","answer": [{"chunkId": 0,"status": "running","reply": {"type": 1,"text": "我","audioUrl": null,"replySource": "CHITCHAT"}}]}