批量查询消息 GetMessages--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

批量查询消息 GetMessages

最近更新时间：2024.04.17 17:35:51首次发布时间：2023.04.24 11:11:46

你可以使用此接口指定消息 ID 对消息进行批量查询。

使用说明

接口行为

你可以调用GetMessages接口，指定你所属的AppId和，会话 ID 和消息 ID，查询指定消息的详细信息。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

注意事项

QPS 不得超过 100。

请求说明

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

请求参数

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

Query

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

Body

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

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Messages	Array of MessageBody	`-`	消息详细信息

MessageBody

参数	类型	示例值	描述
ConversationType	Integer	`1`	会话类型 `1`：单聊。 `2`：群聊。
ConversationShortId	Long	`000001`	会话 ID
MessageId	Long	`000012`	消息 ID
MsgType	Integer	`10001`	消息类型。 `10001`：文本。 `10003`：图片。 `10004`：视频 `10005`：文件 `10006`：音频 `10012`：自定义消息
Content	String	`Your_Content`	消息内容
Ext	JSON Map	`{"key":"value"}`	消息的扩展字段，key 的数据类型为 String，value 的数据类型为 String。
Status	Integer	`0`	消息状态，取值为`0`，表示消息可见。
CreateTime	Long	`1669723135771`	消息创建时间戳，单位为毫秒
Sender	Long	`000010`	消息发送人 UserId
AppId	Integer	`000000`	应用的唯一标志
RefMsgInfo	Object of RefMsgInfo	`-`	引用消息
IndexInConversation	Long	`1669723135894214`	消息在会话中的位置
ClientMsgId	String	`"unique-key"`	消息客户端Id，如果端上消息发送失败，会进行重试，可通过此字段进行幂等判断

RefMsgInfo

参数	类型	示例值	描述
ReferencedMessageId	Long	`10005`	被引用的消息 ID
Hint	String	`[图片]`	消息引用时展示的文本内容
ReferencedMessageType	Integer	`10001`	被引用的消息类型 `10001`：文本。 `10003`：图片。 `10004`：视频 `10005`：文件 `10006`：音频 `10012`：自定义消息
Status	Integer	`0`	被引用的消息状态 `0`：消息可见 `1`：消息已过期 `2`：消息（对用户）不可见 `3`：消息被撤回 `4`：消息本身可见，后因删除不可见

请求示例

POST https://rtc.volcengineapi.com?Action=GetMessages&Version=2020-12-01

{
    "AppId": 000000,
    "ConversationShortId": 000001,
    "MessageIds": [
        000012,
        000013
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "SendMessage",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Messages": [
            {
                "ConversationType": 2,
                "ConversationShortId": 000001,
                "messageId": 000012,
                "MsgType": 10001,
                "Content": "Your_Content",
                "Ext": {
                    "key": "value"
                },
                "Status": 0,
                "CreateTime": 1669723135771,
                "Sender": 000010,
                "AppId": 000000,
                "RefMsgInfo": {
                    "ReferencedMessageId": 000013,
                    "Hint": "[图片]",
                    "ReferencedMessageType": 10001,
                    "Status": 0
                },
                "IndexInConversation": 1669723135894214
            },
            {
                "ConversationType": 2,
                "ConversationShortId": 000001,
                "MessageId": 000014,
                "MsgType": 10001,
                "Content": "222",
                "Ext": {
                    "s:client_message_id": "ae16fb90-2be2-4424-aa6e-3a6e5e53294a"
                },
                "Status": 0,
                "CreateTime": 1669723270194,
                "Sender": 10001,
                "AppId": 000000,
                "RefMsgInfo": {
                    "ReferencedMessageId": 10005,
                    "Hint": "[图片]",
                    "ReferencedMessageType": 10001,
                    "Status": 0
                },
                "IndexInConversation": 1669723270235453
            }
        ]
    }
}

错误码

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