跳到主要内容
Version: 1.0.0

蓝答客服开放 API

客服 V1 API 用于访客认证、会话管理和消息收发。 请求需要携带 X-Open-App-Id、X-Open-Credential-Id、X-Open-Timestamp、X-Open-Nonce 和 X-Open-Signature,签名算法与机器人 V2 API 相同,即「签名 V2」,不存在独立的 「V1 签名规则」。新接入优先使用机器人 V2 API。

所有带 JSON 请求体的请求(POST)都必须显式发送请求头 Content-Type: application/json。 缺失或写错时会返回 HTTP 415 + code 415001(Content-Type 不受支持),属于可自行修正的 客户端问题,不要误判为服务端故障。

业务失败不再以 HTTP 200 承载:访客不存在返回 404 + 400100、访客停用返回 403 + 400101、 会话不存在或关闭失败返回 404 + 400300、分配客服失败返回 409 + 400400、客服账号不存在返回 404 + 400401。失败响应体统一为 ApiResult,判据是 code == "000000"。例外是「查无此人」类 结果,它们仍是 200 + code 000000:GET /api/open/v1/agent/status 用 exists: false 表达客服 不存在,GET /api/open/v1/message/list 用空列表表达访客不存在。完整清单见错误与限制 → 业务错误。

各接口的必需 Scope 见各操作说明;完整映射表见错误与限制 → Scope 与 403。

Authentication​

同时需要 X-Open-Credential-Id、X-Open-Timestamp、X-Open-Nonce、X-Open-Signature,签名规则见开放 API 签名 V2。

Security Scheme Type:

apiKey

Header parameter name:

X-Open-App-Id