REST Resource: phones.agentEvents

Recurso: AgentEvent

Um evento do agente para o usuário.

Representação JSON
{
  "name": string,
  "eventType": enum (AgentEvent.EventType),
  "messageId": string,
  "sendTime": string
}
Campos
name

string

Esse campo é definido pela plataforma RBM. Não inclua esse parâmetro ao criar um evento do agente. O campo resolve "phones/{E.164}/agentEvents/{eventId}", em que {E.164} é o número de telefone do usuário no formato E.164 e {eventId} é o ID do evento do agente atribuído pelo agente.

eventType

enum (AgentEvent.EventType)

O tipo do evento do agente.

messageId

string

O ID da mensagem do usuário a que o evento do agente se refere. Esse campo só é aplicável a eventos do agente do tipo READ.

sendTime

string (Timestamp format)

Esse campo é definido pela plataforma RBM. Não inclua esse campo ao criar uma mensagem do agente. O campo resolve o momento em que o evento é enviado ao usuário.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

AgentEvent.EventType

Tipo de um evento do agente.

Enums
TYPE_UNSPECIFIED Não especificado.
IS_TYPING O agente está digitando.
READ A mensagem enviada por um usuário foi lida pelo agente.

Métodos

create

Envia um evento do agente para um usuário.