UserEvent

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

たとえば、イベントは、ユーザーが入力していることや、エージェントからの以前のメッセージがユーザーによって読まれたことを示すことができます。

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

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。
messageId

string

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

string (Timestamp format)

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

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"。
agentId

string

エージェントの一意の識別子。RCS for Business によって設定されます。