使用ListLiveMessageGroupMessages查询群组消息列表-视频直播-阿里云-视频直播(LIVE)-阿里云帮助中心

调用ListLiveMessageGroupMessages查询群组消息列表。

接口说明

调用本接口前，您必须已经调用 CreateLiveMessageGroup 创建互动消息群组。

QPS 限制

本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:ListLiveMessageGroupMessages

list

*Rtc

acs:live::{#accountId}:rtc/{#AppId}

无

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	需要查询的互动消息应用 ID。	demo
GroupId	string	是	需要查询的群组的 GroupID。	grouptest
PageSize	integer	是	一次显示的消息数量，取值范围[10,50]。	10
SortType	integer	是	排序方式，按消息发送时间先后进行排序。取值： 1：正序 2：逆序枚举值： 1 : 正序 2 : 逆序	1
NextPageToken	integer	否	查询页的起始位置，若为空则默认为首页。	1
MsgType	integer	否	需要查询的消息类型，若为空则默认为全部类型。	1
BeginTime	integer	否	查询起始时间，用 UNIX 时间戳表示，单位：秒。若为空则默认为最早时间。	1697783235
EndTime	integer	否	查询结束时间，用 UNIX 时间戳表示，单位：秒。若为空则默认为最晚时间。	1698301635
DataCenter	string	否	数据中心，需要与 CreateLiveMessageApp 中的数据中心一致，当前支持上海（取值为 cn-shanghai)、新加坡（取值为 ap-southeast-1）。	cn-shanghai

返回参数

名称	类型	描述	示例值
	object	返回参数。
RequestId	string	请求 ID。	1668FDC3-63D7-102F-B5D4-3D2F91D1****
GroupId	string	需要查询的群组的 GroupID。	grouptest
NextPageToken	integer	下一页的起始位置，若没有下一页则为 0。	0
Hasmore	boolean	是否有下一页。	false
MessageList	array<object>	消息列表。
	array<object>	列表详情。
Sender	object	消息参数详情。
UserId	string	消息发送用户的 ID。	uid2
UserInfo	string	消息发送用户的扩展信息。	testusermeta2
Body	string	消息体。	step2 helo, cc group
Timestamp	integer	消息创建时间。用 UNIX 时间戳表示，单位：秒。	1697081134
MsgTid	string	消息标识。	c-1-1-0
MsgType	integer	消息类型。	2
SeqNumber	integer	消息序列号。	1
TotalMessages	integer	总消息数量。	1

示例

正常返回示例

JSON格式

{
  "RequestId": "1668FDC3-63D7-102F-B5D4-3D2F91D1****",
  "GroupId": "grouptest",
  "NextPageToken": 0,
  "Hasmore": false,
  "MessageList": [
    {
      "Sender": {
        "UserId": "uid2",
        "UserInfo": "testusermeta2"
      },
      "Body": "step2 helo, cc group",
      "Timestamp": 1697081134,
      "MsgTid": "c-1-1-0",
      "MsgType": 2,
      "SeqNumber": 1,
      "TotalMessages": 1
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InputInvalid	%s.	输入参数不合法
500	ServerError	%s.	未知错误，请稍后重试或提交工单咨询。
403	NoAuth	%s.	没有权限
404	ResourceNotExist	%s.	请求资源不存在，请检查后重新尝试

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。