Skip to content

通用请求与响应

请求格式

  • 查询接口使用 GET;写入接口使用 POST
  • 普通 POST 使用 application/x-www-form-urlencoded;上传接口使用 multipart/form-data
  • 访客端接口需附加 Authorization: Bearer <visitor-token>
  • 客服端接口依赖已登录的客服会话。未登录时通常返回 code: -1

标准响应

除流式翻译和流式机器人回复外,接口返回统一 JSON 信封:

json
{
  "code": 0,
  "msg": "ok",
  "data": {}
}

code0 表示成功。业务校验失败通常仍返回 HTTP 200,但 code0;访客 Token 缺失、过期或无效时返回对应 HTTP 状态并带相同 JSON 结构。

消息内容

content 为聊天消息正文。文本可直接传递;图片、文件、语音应先调用上传接口,再把上传结果组装为消息内容:

text
![图片](//host/upload/images/...)
file[合同.pdf\t128 KB](//host/upload/files/...)
voice(//host/upload/files/...)

分页

消息历史使用 mid 作为向前翻页游标。首次请求不传 mid,之后将本页最早一条消息的 mid 作为下一页请求的 mid;服务端只返回小于该值的记录。