指定されたユーザーにメッセージを送信します。ユーザーは ReceiverId によって識別されます。
操作説明
1 アカウントあたり、毎秒最大 50 回までこの操作を呼び出すことができます。この制限を超えたリクエストは破棄され、サービス中断が発生します。この操作を呼び出す際は、この制限に注意することを推奨します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:SendLiveMessageUser |
create |
*Rtc
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AppId |
string |
必須 |
メッセージが送信されるインタラクティブメッセージングアプリケーションの ID です。 |
demo |
| ReceiverId |
string |
必須 |
メッセージを受信するユーザーの ID です。ID は最大 64 バイトで、英数字を含めることができます。 説明
メッセージを受信するユーザーがオンラインであることを確認してください。CheckLiveMessageUsersOnline 操作を呼び出して、ユーザーがオンラインであるかどうかをクエリできます。 |
uid2 |
| SenderId |
string |
必須 |
メッセージを送信するユーザーの ID です。ID は最大 64 バイトで、英数字を含めることができます。 |
uid1 |
| SenderInfo |
string |
任意 |
メッセージを送信するユーザーに関する追加情報です。最大 512 バイトまでです。 |
uid1meta1 |
| Body |
string |
任意 |
メッセージ本文です。最大 15 KB までです。 |
hello, user |
| MsgType |
integer |
任意 |
メッセージタイプです。 |
2 |
| MsgTid |
string |
任意 |
メッセージの ID であり、メッセージを削除するために使用できる一意の識別子です。ID は最大 64 バイトで、英数字を含めることができます。 |
169830**** |
| DataCenter |
string |
任意 |
データセンターです。インタラクティブメッセージングアプリケーションを作成するために CreateLiveMessageApp 操作を呼び出したときに指定したデータセンターと同じである必要があります。有効な値:cn-shanghai および ap-southeast-1 (シンガポール)。 |
cn-shanghai |
| HighReliability |
boolean |
任意 |
メッセージを高信頼性メッセージとして設定するかどうかを指定します。高信頼性メッセージは、受信者がメッセージを受信して応答した後にのみ成功が返されることを保証します。受信者が 3 秒以内に応答しない場合、失敗が返されます。
説明
このパラメーターは、クライアント SDK V1.5.1 以降でのみサポートされます。以前の SDK バージョンのクライアントにメッセージを送信する場合、メッセージは確認応答 (ACK) を待たずに正常に送信できます。 |
false |
| Storage |
boolean |
任意 |
メッセージを保存するかどうかを指定します。
|
false |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーターです。 |
||
| RequestId |
string |
リクエスト ID です。 |
6CFDE7AB-571A-14EA-B072-989FF753**** |
| MsgTid |
string |
メッセージの ID であり、メッセージを削除するために使用できる一意の識別子です。ID は最大 64 バイトで、英数字を含めることができます。 |
169830**** |
例
成功レスポンス
JSONJSON
{
"RequestId": "6CFDE7AB-571A-14EA-B072-989FF753****",
"MsgTid": "169830****"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InputInvalid | %s. | |
| 500 | ServerError | %s. | |
| 403 | NoAuth | %s. | |
| 404 | ResourceNotExist | %s. | |
| 408 | UserNotAck | %s. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。