この操作を呼び出して、チャンネルから退出させられたユーザーのリストを取得することができます。 退出操作はクライアントによって行われます。
パラメータのリクエスト
名前 | タイプ | 必須/省略可能 | 説明 |
---|---|---|---|
Action | 文字列 | 必須 | 実行する操作。 値を DescribeRoomKickoutUserList に設定します。 |
AppId | String | 必須 | サービスプロバイダーのアプリケーション ID。 |
RoomId | String | 必須 | チャンネルの ID。 長さの制限:最大 16 文字。 |
Order | String | 任意 | ソート順。
デフォルト値:desc (降順)。 |
PageNum | int | 任意 | ページ番号。
既定値 : 1。 |
PageSize | int | 任意 | 1 ページあたりのレコード数。
デフォルト値:10。 |
レスポンスのパラメータ
名前 | データ型 | 説明 |
---|---|---|
RequestId | String | Alibaba Cloud によって生成された、リクエストに対する GUID。 |
TotalNum | int | レコードの総数。 |
TotalPage | int | 合計ページ数。 |
UserList | JsonArray | ユーザーのリスト。 |
User
名前 | データ型 | 説明 |
---|---|---|
AppUid | String | サードパーティユーザーの ID。 |
OpStartTime | String | 指定されたユーザーの、チャンネルからの退出の開始時刻 (UTC)。 |
OpEndTime | String | 指定されたユーザーの、チャンネルからの退出の終了時刻 (UTC)。 |
コーディング例
リクエスト例
https://live.aliyuncs.com?Action=DescribeRoomKickoutUsers&AppId=xxxx&RoomId=xxx&<Common request parameters>
レスポンスの例
{
"TotalPage": 1,
"TotalNum": 1,
"RequestId": "04CFEE1C-1D4D-4604-AB3C-3ACC3323D628",
"UserList": {
"User" : [
{
"AppUid": "user-100",
"OpStartTime": "2018-05-24T08:58:26Z",
"OpEndTime": "2018-05-24T08:58:26Z",
}
]
}
}
エラーコード
エラーコード | エラーメッセージ | HTTP ステータスコード | 説明 |
---|---|---|---|
InternalError | The request processing has failed due to some unknown error, exception or failure. | 500 | 内部エラーが発生したときに返されるエラーメッセージ。 |