メッセージグループ内のメンバーを一括でミュートします。
操作説明
QPS 制限
この操作のユーザー単位の QPS 制限は、1 秒あたり 100 回の API 呼び出しです。制限を超えると API 呼び出しはスロットリングされ、ビジネスに影響する可能性があります。この操作は適切に呼び出してください。詳細については、「QPS 制限」をご参照ください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:MuteGroupUser |
get |
*Domain
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AppId |
string |
必須 |
インタラクティブメッセージングアプリケーションの ID です。 |
VKL3*** |
| GroupId |
string |
必須 |
メッセージグループ ID です。 |
AE35-****-T95F |
| MuteUserList |
array |
必須 |
ミュートの詳細です。 |
|
|
string |
任意 |
ミュートするユーザー ID のリストです。 |
qu***,yu1*** |
|
| MuteTime |
integer |
任意 |
ミュート期間です。単位:秒。 説明
このパラメーターを指定しない場合、または 0 に設定した場合は、デフォルトのミュート期間 (86400 秒) が使用されます。 |
3600 |
| OperatorUserId |
string |
任意 |
操作者のユーザー ID です。 説明
このパラメーターは必須です。操作者はグループの作成者である必要があります。 |
de1**a0 |
| BroadCastType |
integer |
任意 |
システムメッセージのブロードキャストタイプです。有効な値:
|
2 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ |
||
| RequestId |
string |
リクエスト ID です。 |
16A96B9A-****-CB92E68F4CD8 |
| Result |
object |
返された結果です。 |
|
| Success |
boolean |
ミュート操作が成功したかどうかを示します。有効な値:
|
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "16A96B9A-****-CB92E68F4CD8",
"Result": {
"Success": true
}
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。