この操作を呼び出して、チャンネルに出入りするユーザーに関する通知をチャンネル内のすべてのメンバーにブロードキャストすることができます。
パラメータのリクエスト
名前 | タイプ | 必須/省略可能 | 説明 |
---|---|---|---|
Action | String | 必須 | 実行する操作。 値を SendRoomNotification に設定します。 |
AppId | String | 必須 | サービスプロバイダーのアプリケーション ID。 |
RoomId | String | 必須 | チャンネルの ID。 長さの制限:最大 16 文字。 |
AppUid | String | 任意 | 通知送信者の ID。 長さの制限:最大 16 文字。 |
Data | String | 必須 | 通知内容。 |
Priority | Integer | 任意 | メッセージの優先度。 有効な値:1、2、または 3。
デフォルト値:3。 |
Priority パラメーターに関する備考:
- システム通知および有料ギフトに関する通知は優先度が高いため、受信者に送信する必要があります。 (Topic+QOS_1)
- チャンネル管理メッセージおよび無料ギフトに関する通知の優先度は低くなりますが、受信者に送信する必要があります。 (TopicLow+QOS_1)
- チャンネルに出入りするユーザーに関する通知の優先度は低く、受信者に送信される場合とされない場合があります。 (TopicLow+QOS_2)
レスポンスのパラメータ
名前 | データ型 | 説明 |
---|---|---|
RequestId | String | Alibaba Cloud によって生成された、リクエストに対する GUID。 |
MessageId | String | メッセージ ID。 |
コーディング例
リクエスト例
https://live.aliyuncs.com?Action=SendRoomNotification&AppId=xxxx&RoomId=xxx&Data=xxx&Priority=xxx
レスポンスの例
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
"MessageId": "6445CA5D7FEE5B275DAB6AB2AC1B000C"
}
エラーコード
エラーコード | エラーメッセージ | HTTP ステータスコード | 説明 |
---|---|---|---|
InternalError | The request processing has failed due to some unknown error, exception or failure. | 500 | 内部エラーが発生したときに返されるエラーメッセージ。 |