new_releases Updates: Check the
release notes for new features and product updates.
REST Resource: phones.agentEvents
Stay organized with collections
Save and categorize content based on your preferences.
Resource: AgentEvent
An event from the agent to the user.
| JSON representation |
{
"name": string,
"eventType": enum (AgentEvent.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 (AgentEvent.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. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
|
AgentEvent.EventType
| 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 |
|
|
Sends an event from the agent to a user. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-22 UTC.
[null,null,["Last updated 2025-08-22 UTC."],[[["\u003cp\u003e\u003ccode\u003eAgentEvent\u003c/code\u003e represents an event sent from an agent to a user, containing details about the event's type and status.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eeventType\u003c/code\u003e field defines the type of agent event, which can include \u003ccode\u003eIS_TYPING\u003c/code\u003e or \u003ccode\u003eREAD\u003c/code\u003e, while \u003ccode\u003eTYPE_UNSPECIFIED\u003c/code\u003e means it was not specified.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003emessageId\u003c/code\u003e field indicates which user message the agent event corresponds to, and is specifically used for \u003ccode\u003eREAD\u003c/code\u003e type events.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esendTime\u003c/code\u003e field, formatted as a Timestamp, signifies when the event was dispatched to the user, accepting RFC 3339 formats.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ecreate\u003c/code\u003e method within \u003ccode\u003ephones.agentEvents\u003c/code\u003e allows for the sending of an event from the agent to the user.\u003c/p\u003e\n"]]],[],null,["# REST Resource: phones.agentEvents\n\nResource: AgentEvent\n--------------------\n\nAn event from the agent to the user.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"eventType\": enum (/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentEvents#AgentEvent.EventType), \"messageId\": string, \"sendTime\": string } ``` |\n\n| Fields ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `eventType` | `enum (`[AgentEvent.EventType](/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentEvents#AgentEvent.EventType)`)` The type of the agent event. |\n| `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. |\n| `sendTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#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. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n\nAgentEvent.EventType\n--------------------\n\nType of an agent event.\n\n| Enums ||\n|--------------------|--------------------------------------------------------|\n| `TYPE_UNSPECIFIED` | Not specified. |\n| `IS_TYPING` | The agent is typing. |\n| `READ` | The message sent by a user has been read by the agent. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------------------------------------|------------------------------------------|\n| ### [create](/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentEvents/create) | Sends an event from the agent to a user. |"]]