API 参考

会话

标记会话已读

把会话标记为已读。conversation_id 通过 JSON body 传入（不走 path，因为渠道侧 ID 可能含 @ / : 等字符）。WhatsApp 消息级已读需要成对传入 up_to_message_id 与 up_to_message_sender_id；群聊发送者使用对应 webhook 的 data.sender.id。省略这两个字段表示把整条会话标记为已读，只传其中一个会返回 400 invalid_request。

POSThttps://api.unifyport.ai/v1/accounts/{account_id}/conversations/read

调用前准备

在服务端使用资源所属工作区的 X-Api-Key。运行示例前替换所有占位符。

参数从哪里取得
account_id
从创建或查询账号的响应取得 data.id。账号标识属于 X-Api-Key 对应的工作区。 获取账号

请求参数

请求头

X-Api-Key
string必填

工作区 API Key，工作区由该请求头解析得到。

Content-Type
string必填

发送 JSON 请求体时使用 application/json。

路径参数

account_id
string必填

用于该 conversations 路由的标识符。

请求体

conversation_id
string必填

目标会话标识。

up_to_message_id
string

可选。一个 WhatsApp 消息 ID，或属于同一发送者的多个消息 ID（英文逗号分隔）；必须与 up_to_message_sender_id 成对传入。省略两者时标记整个会话已读。

up_to_message_sender_id
string

up_to_message_id 中所有消息的渠道侧发送者标识；群聊应传 Webhook 事件中的 data.sender.id。多个消息 ID 必须属于同一发送者。

如何理解结果

按文档解释响应字段和 HTTP 状态。204 成功响应没有响应体，排查时使用 X-Request-Id。下一步操作见相关链接。

响应 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "ok": true
  }
}

响应体

ok
boolean

操作成功时始终为 true；失败时返回非 2xx 状态码而非该字段。

响应

200

200 OK

请求成功，响应体示例如上。

400

请求错误

请求体、路径或参数不合法。

401

未授权

X-Api-Key 请求头缺失或无效。

404

未找到

未找到请求的渠道资源。

409

冲突

当前操作与已有的渠道账号或资源冲突。

500

服务端错误

服务端遇到了未预期的错误。

501

渠道未实现

所选渠道尚未实现该操作。

502

上游网关错误

渠道适配器或上游渠道未能完成该操作。

失败后怎么处理

检查 HTTP 状态和 error.code/numeric_code，保存 request_id 用于排查。按原因修正参数、继续授权或检查运行态。重试发送及其他写操作前先确认上一次结果，避免重复操作。 错误码参考

invalid_request · 10000 · 400
检查必填字段、格式和渠道条件，修正请求后再调用。
invalid_api_key · 11001 · 401
检查 X-Api-Key 是否正确、工作区是否有效。