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

分批查询会话中的消息 GetConversationMessages

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

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

你可以使用此接口批量查询会话中的消息。

接口行为

你可以调用GetConversationMessages接口,指定你所属的AppId、会话 ID、查询起始位置和查询条数批量查询会话中的消息。

一次最多查询 20 条消息。

调用接口

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

接口限制

QPS 不得超过 100。

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

参数名类型必填示例值描述
AppIdInt000000应用的唯一标志
ConversationShortIdInt000001会话 ID
CursorInt1666495802476129查询起始位置,即查询起始消息的 Index
LimitInt3查询条数
ReverseInt0查询方向。
  • 0:正向查询
  • 1:反向查询
默认值为 0。值不合法时自动调整为默认值。
直播群只能取 1

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "ConversationShortId":000001,
    "Cursor":1666495802476129,
    "Limit":3,
    "Reverse":0
}

返回调用结果

返回参数说明

返回结果参看 BaseResponse

其中 Result 的结构如下:

参数名类型描述
HasMoreBool是否还有下一页
NewCursorInt下一页起始位置
MessagesMessageBody消息详细信息

正常返回示例

{
    "ResponseMetadata": {
	      "RequestId": "Your_RequestId",    
        "Action": "GetConversationMessages",
        "Version": "2020-12-01",
        "Service": "rtc",        
        "Region": "cn-north-1"
    },
    "Result": {
        "HasMore": true,
        "NewCursor": 1669694740483825,
        "Messages": [
            {
                "ConversationType": 2,
                "ConversationShortId": 000001,
                "MessageId": 000012,
                "MsgType": 10001,
                "Content": "Content1",
                "Ext": {
                    "key": "value"
                },
                "Status": 0,
                "CreateTime": 1669723106144,
                "Sender": 000010,
                "AppId": 000000,
                "RefMsgInfo": {
                    "ReferencedMessageId": 000013, 
                    "Hint": "[图片]",
                    "ReferencedMessageType": 10001,
                    "Status": 0
                },
                "IndexInConversation": 1669723106241201
            },
            {
                "ConversationType": 2,
                "ConversationShortId": 000001,
                "MessageId": 000014,
                "MsgType": 10001,
                "Content": "Content2",
                "Ext": {
                    "key": "value"
                },
                "Status": 0,
                "CreateTime": 1669723123203,
                "Sender": 000010,
                "AppId": 000000,
                "RefMsgInfo": {
                    "ReferencedMessageId": 000013,
                    "Hint": "[图片]",
                    "ReferencedMessageType": 10001,
                    "Status": 0
                },
                "IndexInConversation": 1669723123272087
            },
            {
                "ConversationType": 2,
                "ConversationShortId": 000001,
                "MessageId": 000015,
                "MsgType": 10001,
                "Content": "Content3",
                "Ext": {
                    "key": "value"
                },
                "Status": 0,
                "CreateTime": 1669723270194,
                "Sender": 000010,
                "AppId": 000000,
                "RefMsgInfo": {
                    "ReferencedMessageId": 000013,
                    "Hint": "[图片]",
                    "ReferencedMessageType": 10001,
                    "Status": 0
                },
                "IndexInConversation": 1669723270235453
            }
        ]
    }
}