获取消息的已读回执详情--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

获取消息的已读回执详情

最近更新时间：2024.05.13 15:26:49首次发布时间：2024.03.08 14:36:52

你可以调用GetMessagesReadReceipt接口，指定你所属的AppId、会话 Id 和消息Id获得消息的已读详情。

当前仅单聊和群聊支持

注意事项

最大请求次数：100 次/秒

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=GetMessagesReadReceipt&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetMessagesReadReceipt`	接口名称。当前 API 的名称为 `GetMessagesReadReceipt`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`666675`	应用的唯一标志
ConversationShortId	Long	是	`1691070514797524200`	会话Id
MessageIds	Array of Long	是	`[1709040620191372977]`	消息Id

返回参数

本接口无特有的返回参数。公共返回参数请见返回结构。

参数	类型	示例值	描述
ReadReceipt	Array of ReadReceipt		已读回执详情

ReadReceipt

参数	类型	示例值	描述
MessageId	Long	`1709040620191372977`	消息Id
ConversationShortId	Long	`1691070514797524328`	会话Id
ReceiverIsRead	Boolean	`false`	单聊中消息的接收方是否已读（只有单聊会话这个字段才有意义）
ReadUserIds	Array of Long	`[]`	消息已读的UserId列表
UnReadUserIds	Array of Long	`[30341]`	消息未读的UserId列表

请求示例

POST https://rtc.volcengineapi.com?Action=GetMessagesReadReceipt&Version=2020-12-01
{
    "AppId":00000,
    "ConversationShortId":1691070514797524328,
    "MessageIds":[1709040620191372977]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240227214230259C67C52D053506DF0B",
        "Action": "GetMessagesReadReceipt",
        "Version": "",
        "Service": "",
        "Region": ""
    },
    "Result": {
        "ReadReceipt": [
            {
                "MessageId": 1709040620191372977,
                "ConversationShortId": 1691070514797524328,
                "ReceiverIsRead": false,
                "ReadUserIds": [],
                "UnReadUserIds": [
                    30341
                ]
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。