調用CheckLiveMessageUsersOnline查詢指定的使用者是否線上。
介面說明
本介面的單使用者 QPS 限制為 50 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:CheckLiveMessageUsersOnline |
none |
*Domain
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| AppId |
string |
是 |
應用 ID。 |
demo |
| UserIds |
array |
是 |
需要查詢的使用者列表。 |
|
|
string |
否 |
需要查詢的使用者識別碼。多個用半形逗號(,)隔開。單次查詢使用者數量範圍[1,10]。 |
uid |
|
| DataCenter |
string |
否 |
資料中心,需要與 CreateLiveMessageApp 中的資料中心一致,當前支援上海(取值為 cn-shanghai)、新加坡(取值為 ap-southeast-1)。 |
cn-shanghai |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回參數。 |
||
| RequestId |
string |
請求 ID。 |
178F572F-AECF-100B-937A-B8047B4D**** |
| UserList |
array<object> |
查詢的使用者列表。 |
|
|
object |
使用者資訊。 |
||
| Online |
boolean |
使用者是否線上。 |
false |
| UserId |
string |
使用者識別碼。 |
uid1 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "178F572F-AECF-100B-937A-B8047B4D****",
"UserList": [
{
"Online": false,
"UserId": "uid1"
}
]
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InputInvalid | %s. | 輸入參數不合法 |
| 500 | ServerError | %s. | 未知錯誤,請稍後重試或提交工單諮詢。 |
| 403 | NoAuth | %s. | 沒有許可權 |
| 404 | ResourceNotExist | %s. | 請求資源不存在,請檢查後重新嘗試 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。