REST Resource: phones.agentEvents

Ressource: AgentEvent

Ein Ereignis vom Agent für den Nutzer.

JSON-Darstellung
{
  "name": string,
  "eventType": enum (AgentEvent.EventType),
  "messageId": string,
  "sendTime": string
}
Felder
name

string

Dieses Feld wird von der RBM-Plattform festgelegt. Geben Sie ihn nicht an, wenn Sie ein Agent-Ereignis erstellen. Das Feld löst „phones/{E.164}/agentEvents/{eventId}“ auf, wobei {E.164} die Telefonnummer des Nutzers im E.164-Format und {eventId} die vom Agent zugewiesene ID des Agent-Ereignisses ist.

eventType

enum (AgentEvent.EventType)

Der Typ des Agent-Ereignisses.

messageId

string

Die ID der Nutzernachricht, auf die sich das Agent-Ereignis bezieht. Dieses Feld gilt nur für Agent-Ereignisse vom Typ READ.

sendTime

string (Timestamp format)

Dieses Feld wird von der RBM-Plattform festgelegt. Geben Sie ihn nicht an, wenn Sie eine Agent-Nachricht erstellen. Das Feld gibt den Zeitpunkt an, zu dem das Ereignis an den Nutzer gesendet wird.

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".

AgentEvent.EventType

Typ eines Agent-Ereignisses.

Enums
TYPE_UNSPECIFIED Nicht angegeben.
IS_TYPING Der Agent schreibt gerade.
READ Die von einem Nutzer gesendete Nachricht wurde vom Agent gelesen.

Methoden

create

Sendet ein Ereignis vom Agent an einen Nutzer.