查询消息列表。
接口说明
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:ListMessage |
get |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
GroupId |
string |
是 |
消息组 ID。 |
AE35-****-T95F |
AppId |
string |
是 |
互动消息应用 ID。 |
VKL3*** |
Type |
integer |
否 |
用户自定义消息类型,需大于 10000。 |
10002 |
SortType |
integer |
否 |
排列方式,取值:
|
1 |
PageNum |
integer |
是 |
页码,默认值:1。取值范围:1~100000。 |
10 |
PageSize |
integer |
是 |
单页显示用户的数量,默认值:20。取值范围:1~50。 |
20 |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
Schema of Response |
||
RequestId |
string |
请求 ID。 |
16A96B9A-****-CB92E68F4CD8 |
Result |
object |
返回结果。 |
|
HasMore |
boolean |
是否还有下一页,取值:
|
false |
MessageList |
array |
消息列表。 |
|
object |
|||
Data |
string |
消息体,JSONString 类型。 |
test |
GroupId |
string |
消息组 ID。 |
AE35-****-T95F |
MessageId |
string |
消息 ID。 |
qt*** |
SenderId |
string |
消息发送者 ID。 |
yi*** |
Type |
integer |
消息类型。 |
10002 |
示例
正常返回示例
JSON
格式
{
"RequestId": "16A96B9A-****-CB92E68F4CD8",
"Result": {
"HasMore": false,
"MessageList": [
{
"Data": "test",
"GroupId": "AE35-****-T95F",
"MessageId": "qt***",
"SenderId": "yi***",
"Type": 10002
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。