调用CheckLiveMessageUsersOnline查询指定的用户是否在线。
QPS限制
本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | CheckLiveMessageUsersOnline | 系统规定参数。取值:CheckLiveMessageUsersOnline。 |
AppId | String | 是 | demo | 应用ID。 |
UserIds | Array of String | 是 | ["uid1","uid2"] | 需要查询的用户ID。多个用半角逗号(,)隔开。单次查询用户数量范围[1,10]。 |
DataCenter | String | 否 | cn-shanghai | 数据中心,需要与CreateLiveMessageApp中的数据中心一致,当前支持上海(取值为cn-shanghai)、新加坡(取值为ap-southeast-1)。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | 178F572F-AECF-100B-937A-B8047B4D**** | 请求ID。 |
UserList | Array of Users | 查询的用户列表。 |
|
UserId | String | uid1 | 用户ID。 |
Online | Boolean | false | 用户是否在线。 |
示例
请求示例
http(s)://live.aliyuncs.com?Action=CheckLiveMessageUsersOnline
&AppId=demo
&UserIds=["uid1","uid2"]
&DataCenter=cn-shanghai
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CheckLiveMessageUsersOnlineResponse>
<RequestId>178F572F-AECF-100B-937A-B8047B4D****</RequestId>
<UserList>
<UserId>uid1</UserId>
<Online>false</Online>
</UserList>
</CheckLiveMessageUsersOnlineResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "178F572F-AECF-100B-937A-B8047B4D****",
"UserList" : [ {
"UserId" : "uid1",
"Online" : false
} ]
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | InputInvalid | %s. | 输入参数不合法 |
403 | NoAuth | %s. | 没有权限 |
404 | ResourceNotExist | %s. | 请求资源不存在,请检查后重新尝试 |
500 | ServerError | %s. | 未知错误,请稍后重试或提交工单咨询。 |
访问错误中心查看更多错误码。
文档内容是否对您有帮助?