REST Resource: phones.agentEvents

Ressource : AgentEvent

Événement envoyé par l'agent à l'utilisateur.

Représentation JSON
{
  "name": string,
  "eventType": enum (AgentEvent.EventType),
  "messageId": string,
  "sendTime": string
}
Champs
name

string

Ce champ est défini par la plate-forme RBM. Ne l'incluez pas lorsque vous créez un événement d'agent. Le champ résout "phones/{E.164}/agentEvents/{eventId}", où {E.164} est le numéro de téléphone de l'utilisateur au format E.164 et {eventId} est l'ID attribué par l'agent à l'événement d'agent.

eventType

enum (AgentEvent.EventType)

Type d'événement de l'agent.

messageId

string

ID du message utilisateur auquel se rapporte l'événement d'agent. Ce champ ne s'applique qu'aux événements d'agent de type READ.

sendTime

string (Timestamp format)

Ce champ est défini par la plate-forme RBM. Ne l'incluez pas lorsque vous créez un message d'agent. Le champ indique l'heure à laquelle l'événement est envoyé à l'utilisateur.

Utilise la norme RFC 3339, où la sortie générée utilise le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

AgentEvent.EventType

Type d'événement d'agent.

Enums
TYPE_UNSPECIFIED Non spécifié.
IS_TYPING L'agent est en train d'écrire.
READ L'agent a lu le message envoyé par l'utilisateur.

Méthodes

create

Envoie un événement de l'agent à un utilisateur.