OpenMax
免费试用

Apps API · Read Receipts

Read Receipts: 3 个接口

← 全部分组

POST /api/v1/conversations/{conversation_id}/read

Mark conversation read

权限(scope): messages:read_state:write · 调用方式: appToken · operationId: mark-conversation-read

Required app scope: messages:read_state:write.

Marks a conversation read through the given sequence. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
conversation_id path string (uuid) 是 Conversation UUID

请求体

application/json · MarkReadRequestBody

字段 类型 必填 说明
read_until_seq integer (int64) 是 Read until sequence

回包

GET /api/v1/conversations/{conversation_id}/read-cursors

Get conversation read cursors

权限(scope): messages:read_state:read · 调用方式: appToken · operationId: get-conversation-read-cursors

Required app scope: messages:read_state:read.

Returns every member's read/ack cursor pair for read receipts: a message with seq <= last_read_seq is read by that member, seq <= last_ack_seq is delivered. Capped at 500 members ordered by last_read_seq descending; member_count carries the true total when truncated. Caller must be a non-observer member (403 for observers, 404 otherwise). Returns 412 when read receipts are disabled for the org or conversation. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
conversation_id path string (uuid) 是 Conversation UUID

回包

GET /api/v1/conversations/{conversation_id}/unread

Get conversation unread count

权限(scope): messages:read_state:read · 调用方式: appToken · operationId: get-conversation-unread-count

Required app scope: messages:read_state:read.

Returns unread count for the current principal in a conversation. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
conversation_id path string (uuid) 是 Conversation UUID

回包