Method: phones.agentEvents.create

エージェントからユーザーにイベントを送信します。

エージェント イベントは、エージェントがユーザーからのメッセージを読んだことや、エージェントが入力中であることを示すために使用できます（これにより、RCS for Business のエクスペリエンスに人間味を加えることができます）。ユーザーが RCS を有効にしていない場合、RCS for Business プラットフォームは NOT_FOUND（HTTP 404）エラーを返します。ユーザーが RCS を有効にしているが、現時点で連絡が取れない場合、プラットフォームは 200 OK レスポンスを返し、イベントタイプに基づいて配信を処理します。エージェント イベントは、最大 30 日間ストア アンド フォワード キューにキューイングされ、ユーザーがオンラインに戻ると配信されます。IS_TYPING イベントのみがエフェメラルで、キューに登録されません。

エージェント メッセージとは異なり、エージェント イベントは送信後に取り消すことはできません。

HTTP リクエスト

POST https://rcsbusinessmessaging.googleapis.com/v1/{parent=phones/*}/agentEvents

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

「phones/{E.164}」。{E.164} は、E.164 形式のユーザーの電話番号です。たとえば、米国の電話番号 +1-222-333-4444 のユーザーの場合、値は phones/+12223334444 となり、結果のエンドポイントは https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentEvents となります。

クエリ パラメータ

パラメータ
eventId

string

エージェントによって割り当てられたイベントの ID。これは、https://tools.ietf.org/html/rfc4122 で定義されている UUID である必要があります。RCS for Business プラットフォームは、同じエージェントから送信された以前のメッセージまたはイベントで使用された ID を含むエージェント メッセージを無視します。
agentId

string

必須。エージェントの固有識別子。

リクエストの本文

リクエストの本文には AgentEvent のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には、新しく作成された AgentEvent のインスタンスが含まれます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/rcsbusinessmessaging

詳細については、OAuth 2.0 Overview をご覧ください。