查询订阅房间消息列表 -

QPS限制

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListEventSub	系统规定参数。取值：ListEventSub。
AppId	String	是	9qb1****	应用ID。

返回数据

名称	类型	示例值	描述
RequestId	String	AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08	请求ID。
Subscribers	Array of data		订阅事件列表。
SubId	String	09be0d2254cb5a89f4cbd86403ec****	订阅事件ID。
ChannelId	String	testmodify	订阅的频道ID。
Events	Array of String	ChannelEvent	订阅的事件，取值： ChannelEvent：频道事件，包括频道开启与关闭。 UserEvent：用户事件，包括用户入离会等。
CallbackUrl	String	http://****.com/callback	回调地址。
CreateTime	String	2023-08-18 10:14:49	创建订阅时间。东八区时间，是UTC+8时区的时间。格式：yyyy-MM-dd hh:mm:ss。
ModifyTime	String	2023-08-18 10:14:49	修改订阅时间。东八区时间，是UTC+8时区的时间。格式：yyyy-MM-dd hh:mm:ss。
Users	Array of String	testUser	只回调此用户的事件，不建议与Roles同用。
Roles	Integer	1	回调哪个角色的事件，取值： 1：只回调主播事件。 2：只回调观众事件。无值或其他值表示回调所有用户事件。说明创建订阅不再支持此参数，此参数已废弃。

示例

请求示例

http(s)://live.aliyuncs.com?Action=ListEventSub
&AppId=9qb1****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListEventSubResponse>
    <RequestId>AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08</RequestId>
    <Subscribers>
        <SubId>09be0d2254cb5a89f4cbd86403ec****</SubId>
        <ChannelId>testmodify</ChannelId>
        <Events>ChannelEvent</Events>
        <CallbackUrl>http://****.com/callback</CallbackUrl>
        <CreateTime>2023-08-18 10:14:49</CreateTime>
        <ModifyTime>2023-08-18 10:14:49</ModifyTime>
        <Users>testUser</Users>
        <Roles>1</Roles>
    </Subscribers>
</ListEventSubResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08",
  "Subscribers" : [ {
    "SubId" : "09be0d2254cb5a89f4cbd86403ec****",
    "ChannelId" : "testmodify",
    "Events" : [ "ChannelEvent" ],
    "CallbackUrl" : "http://****.com/callback",
    "CreateTime" : "2023-08-18 10:14:49",
    "ModifyTime" : "2023-08-18 10:14:49",
    "Users" : [ "testUser" ],
    "Roles" : 1
  } ]
}

错误码

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

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