REST Resource: phones.agentEvents

Ресурс: AgentEvent

Событие от агента к пользователю.

JSON-представление
{
  "name": string,
  "eventType": enum (AgentEvent.EventType),
  "messageId": string,
  "sendTime": string
}
Поля
name

string

Это поле задаётся платформой RBM. Не указывайте его при создании события агента. Поле преобразуется в "phones/{E.164}/agentEvents/{eventId}", где {E.164} — номер телефона пользователя в формате E.164, а {eventId} — назначенный агентом идентификатор события агента.

eventType

enum ( AgentEvent.EventType )

Тип события агента.

messageId

string

Идентификатор пользовательского сообщения, к которому относится событие агента. Это поле применимо только для событий агента типа READ.

sendTime

string ( Timestamp format)

Это поле задаётся платформой RBM. Не включайте его при создании сообщения агента. Поле определяет время отправки события пользователю.

Использует 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" .

AgentEvent.EventType

Тип события агента.

Перечисления
TYPE_UNSPECIFIED Не указан.
IS_TYPING Агент печатает.
READ Сообщение, отправленное пользователем, прочитано агентом.

Методы

create

Отправляет событие от агента пользователю.