ServerEvent

エージェントとユーザーの会話に関連する、サーバーサイドで発生したイベント。

たとえば、bot がメッセージの TTL を設定し、TTL が期限切れになると、このイベントが起動し、bot メッセージがタイムアウトしたことをパートナーに通知します。

ServerEvent は「data」「message」フィールドのエージェントが Pub/Sub サブスクリプションから受信するオブジェクトです。「データ」フィールドは Base64 でエンコードされた文字列です。エージェントは、ServerEvent 構造に合わせてデコードする必要があります。

JSON 表現 
{
  "phoneNumber": string,
  "agentId": string,
  "messageId": string,
  "eventType": enum (ServerEvent.EventType),
  "eventId": string,
  "sendTime": string
}
フィールド
phoneNumber

string

イベントに関与しているユーザーの電話番号（E.164 形式）。
agentId

string

エージェントの一意の識別子。RCS ビジネス メッセージによって設定されます。
messageId

string

イベントに関連付けられているメッセージの RCS メッセージ ID。
eventType

enum (ServerEvent.EventType)

イベントのタイプ。
eventId

string

イベント インスタンスに割り当てられる一意のイベント ID。
sendTime

string (Timestamp format)

サーバーがイベントを送信する時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。