ユーザーがインタラクティブメッセージンググループにいるかどうかをクエリします。
操作説明
この操作を呼び出す前に、CreateLiveMessageGroup 操作を呼び出してインタラクティブメッセージンググループを作成済みであることを確認してください。
QPS 制限
1 アカウントあたり、毎秒 50 回までこの操作を呼び出すことができます。この制限を超えたリクエストは破棄され、サービス中断が発生します。この操作を呼び出す際は、この制限に注意することを推奨します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:CheckLiveMessageUsersInGroup |
none |
*Rtc
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AppId |
string |
必須 |
アプリケーション ID。 |
demo |
| GroupId |
string |
必須 |
グループ ID。 |
grouptest |
| UserIds |
array |
必須 |
クエリするユーザーのリスト。 |
|
|
string |
必須 |
ユーザー ID。複数のユーザー ID はコンマ (,) で区切ります。各呼び出しでクエリできるユーザー数は 1〜10 です。 |
uid |
|
| DataCenter |
string |
任意 |
データセンター。CreateLiveMessageApp 操作を呼び出してインタラクティブメッセージングアプリケーションを作成したときに指定したデータセンターと同じである必要があります。有効な値:cn-shanghai および ap-southeast-1 (シンガポール)。 |
cn-shanghai |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。 |
F1F68D81-1543-1FE4-B56E-82200DD2**** |
| Users |
array<object> |
クエリされたユーザーのリスト。 |
|
|
object |
|||
| UserId |
string |
ユーザーの ID。 |
uid1 |
| Online |
boolean |
ユーザーがグループ内にいるかどうかを示します。 |
false |
例
成功レスポンス
JSONJSON
{
"RequestId": "F1F68D81-1543-1FE4-B56E-82200DD2****",
"Users": [
{
"UserId": "uid1",
"Online": false
}
]
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InputInvalid | %s. | |
| 500 | ServerError | %s. | |
| 403 | NoAuth | %s. | |
| 404 | ResourceNotExist | %s. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。