ServerEvent

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

たとえば、ボットがメッセージの TTL を設定し、TTL が期限切れになった場合、このイベントが発生して、ボット メッセージがタイムアウトしたことがパートナーに通知されます。

ServerEvent は、エージェントが Pub/Sub サブスクリプションから受信する「message」オブジェクトの「data」フィールドに表示されます。「data」フィールドは、エージェントが ServerEvent 構造と一致するようにデコードする必要がある base64 でエンコードされた文字列です。

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)

サーバーがイベントを送信した時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"