You need to enable JavaScript to run this app.
导航

批量查询消息 GetMessages

最近更新时间2023.11.22 10:54:17

首次发布时间2023.04.24 11:11:46

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

接口行为

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

调用接口

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

接口限制

QPS 不得超过 100。

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名类型必填示例值描述
ActionStringGetMessages接口名称,本接口取值:GetMessages
VersionString2020-12-01接口版本,本接口取值:2020-12-01

Body

参数名类型必填示例值描述
AppIdInt000000应用的唯一标志
ConversationShortIdInt000001会话 ID
MessageIdsArray of Int[10003]消息 ID

请求示例代码

Query

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

Body

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

返回调用结果

返回参数说明

返回结果参看 BaseResponse

其中 Result 的结构如下:

参数名类型描述
MessagesArray of MessageBody消息详细信息

正常返回示例

{
    "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
            }
        ]
    }
}