Updates: Check the release notes for new features and product updates.

REST Resource: phones.agentEvents

Resource: AgentEvent

An event from the agent to the user.

JSON representation
{
  "name": string,
  "eventType": enum (EventType),
  "messageId": string,
  "sendTime": string
}
Fields
name

string

This field is set by the RBM platform. Do not include it when creating an agent event. The field resolves "phones/{E.164}/agentEvents/{eventId}", where {E.164} is the user's phone number in E.164 format and {eventId} is the agent-assigned ID of the agent event.

eventType

enum (EventType)

The type of the agent event.

messageId

string

The ID of the user message that the agent event pertains to. This field is only applicable for agent events of type READ.

sendTime

string (Timestamp format)

This field is set by the RBM platform. Do not include it when creating an agent message. The field resolves the time when the event is sent to the user.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

EventType

Type of an agent event.

Enums
TYPE_UNSPECIFIED Not specified.
IS_TYPING The agent is typing.
READ The message sent by a user has been read by the agent.

Methods

create

Sends an event from the agent to a user.