UserEvent

Ein Ereignis, das auf dem RCS-Client des Nutzers aufgetreten ist und mit einer Unterhaltung mit dem Agent zusammenhängt.

So kann ein Ereignis beispielsweise darauf hinweisen, dass der Nutzer gerade schreibt oder dass eine frühere Nachricht des Agents vom Nutzer gelesen wurde.

Das UserEvent wird im Feld „data“ des Nachrichtenobjekts angezeigt, das der Agent von seinem Google Cloud Pub/Sub-Abo erhält. Das Feld „data“ ist ein base64-codierter String, den der Agent decodieren muss, um der UserEvent-Struktur zu entsprechen.

JSON-Darstellung
{
  "senderPhoneNumber": string,
  "eventType": enum (UserEvent.EventType),
  "eventId": string,
  "messageId": string,
  "sendTime": string,
  "agentId": string
}
Felder
senderPhoneNumber

string

Telefonnummer des Nutzers im E.164-Format, der an dem Ereignis beteiligt ist.

eventType

enum (UserEvent.EventType)

Ereignistyp

eventId

string

Eine eindeutige Ereignis-ID, die vom RCS-Client des sendenden Nutzers zugewiesen wird. Agents sollten Ereignisse mit demselben Paar (eventId, absenderPhoneNumber) als unbeabsichtigte Duplikate behandeln.

messageId

string

Die ID der Nachricht, die dem Ereignis zugeordnet ist. Das kann z. B. eine Nachricht sein, die an den RCS-Client des Nutzers gesendet oder vom Nutzer gelesen wurde. Dieses Feld wird für DELIVERED- und READ-Ereignisse ausgefüllt.

sendTime

string (Timestamp format)

Zeitpunkt, zu dem der RCS-Client das Ereignis sendet.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

agentId

string

Die eindeutige Kennung des Agents. Von RCS Business Messaging festgelegt.