UserEvent

ユーザーの RCS クライアントで発生し、エージェントとの会話に関連するイベント。

たとえば、イベントは、ユーザーが入力中であることや、エージェントからの以前のメッセージをユーザーが読んだことを示します。

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

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

string

イベントに参加したユーザーの電話番号（E.164 形式）。
eventType

enum (UserEvent.EventType)

イベントのタイプ。
eventId

string

送信元ユーザーの RCS クライアントによって割り当てられた一意のイベント ID。エージェントは、同じ（eventId、senderPhoneNumber）ペアのイベントを意図しない重複として扱う必要があります。
messageId

string

イベントに関連付けられているメッセージの ID。ユーザーの RCS クライアントに配信されたメッセージや、ユーザーによって読み取られたメッセージなど。このフィールドは、DELIVERED イベントと READ イベントの場合に入力されます。
sendTime

string (Timestamp format)

RCS クライアントがイベントを送信した時刻。

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

string

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