エージェントからユーザーにメッセージを送信します。
エージェントがメッセージを正常に送信するには、RCS が有効になっていて、ユーザーが RBM プラットフォームから到達可能である必要があります。メッセージが正常に送信されると、エラーなしで呼び出しが返されます。それ以外の場合、エージェントはエラーコードを受け取ります。
ユーザーがオンラインの場合、RBM プラットフォームはメッセージをすぐに配信します。それ以外の場合、RBM プラットフォームはメッセージをキューに登録し、ユーザーが次回オンラインになったときに配信します。
RBM プラットフォームでは、以前のメッセージまたは同じエージェントから送信されたイベントで使用された ID で送信されたエージェント メッセージは無視されます。
エージェント メッセージは、送信されてから配信されるまでの間に取り消される可能性があります。
HTTP リクエスト
POST https://rcsbusinessmessaging.googleapis.com/v1/{parent=phones/*}/agentMessages
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
"phones/{E.164}"({E.164} は、E.164 形式のユーザーの電話番号)たとえば、米国の電話番号が +1-222-333-4444 の場合、値は phone/+12223334444、エンドポイントは https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages となります。 |
クエリ パラメータ
パラメータ | |
---|---|
messageId |
エージェントによって割り当てられたメッセージの一意の ID。https://tools.ietf.org/html/rfc4122 で定義されているとおり、UUID である必要があります。RBM プラットフォームでは、以前のメッセージまたは同じエージェントから送信されたイベントで使用された ID で送信されたエージェント メッセージは無視されます。 |
agentId |
必須。エージェントの一意の識別子。 |
リクエスト本文
リクエストの本文には AgentMessage
のインスタンスが含まれています。
レスポンスの本文
成功した場合、レスポンスの本文には、新しく作成された AgentMessage
のインスタンスが含まれます。
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/rcsbusinessmessaging
詳細については、OAuth 2.0 の概要をご覧ください。