new_releases Actualizaciones: Consulte las
notas de la versión para conocer las funciones nuevas y las actualizaciones de productos.
ServerEvent
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Es un evento que ocurrió del lado del servidor y que se relaciona con una conversación entre un agente y un usuario.
Por ejemplo, si el bot establece un TTL para el mensaje y este vence, se activará este evento para notificar al socio que se agotó el tiempo de espera del mensaje del bot.
El objeto ServerEvent aparece en el campo "data" del objeto "message" que el agente recibe de su suscripción a Pub/Sub. El campo "data" es una cadena codificada en base64 que el agente debe decodificar para que coincida con la estructura de ServerEvent.
| Representación JSON |
{
"phoneNumber": string,
"agentId": string,
"messageId": string,
"eventType": enum (ServerEvent.EventType),
"eventId": string,
"sendTime": string
} |
| Campos |
phoneNumber |
string
Número de teléfono (en formato E.164) del usuario involucrado en el evento.
|
agentId |
string
Es el identificador único del agente. Establecido por RCS Business Messaging.
|
messageId |
string
Es el ID del mensaje RCS asociado al evento.
|
eventType |
enum (ServerEvent.EventType)
Es el tipo de evento.
|
eventId |
string
Es un ID de evento único asignado a la instancia del evento.
|
sendTime |
string (Timestamp format)
Fecha y hora en que el servidor envía el evento. Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
|
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-08-22 (UTC)
[null,null,["Última actualización: 2025-08-22 (UTC)"],[[["\u003cp\u003eServerEvents are notifications about occurrences related to conversations between agents and users, such as when a bot message's TTL expires.\u003c/p\u003e\n"],["\u003cp\u003eThese events are delivered within the "data" field of a "message" object in a Pub/Sub subscription, requiring base64 decoding by the agent.\u003c/p\u003e\n"],["\u003cp\u003eEach ServerEvent contains fields such as \u003ccode\u003ephoneNumber\u003c/code\u003e, \u003ccode\u003eagentId\u003c/code\u003e, \u003ccode\u003emessageId\u003c/code\u003e, \u003ccode\u003eeventType\u003c/code\u003e, \u003ccode\u003eeventId\u003c/code\u003e, and \u003ccode\u003esendTime\u003c/code\u003e to provide specific context.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eeventType\u003c/code\u003e field specifies the type of the event, while \u003ccode\u003esendTime\u003c/code\u003e indicates the server's event dispatch time in RFC 3339 format.\u003c/p\u003e\n"],["\u003cp\u003eThe information is structured in a JSON format that contains information regarding the server event and it's corresponding data.\u003c/p\u003e\n"]]],[],null,["# ServerEvent\n\nAn event that occurred server side that is related to a conversation between an agent and a user.\n\nFor example, if the bot sets a TTL for the message and the TTL expires, this event will be fired to notify the partner that the bot message timed out.\n\nThe ServerEvent appears in the \"data\" field of the \"message\" object that the agent receives from its Pub/Sub subscription. The \"data\" field is a base64-encoded string that the agent must decode to match the ServerEvent structure.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"phoneNumber\": string, \"agentId\": string, \"messageId\": string, \"eventType\": enum (/business-communications/rcs-business-messaging/reference/rest/v1/ServerEvent.EventType), \"eventId\": string, \"sendTime\": string } ``` |\n\n| Fields ||\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `phoneNumber` | `string` Phone number (in E.164 format) of the user involved in the event. |\n| `agentId` | `string` The agent's unique identifier. Set by RCS Business Messaging. |\n| `messageId` | `string` The RCS message ID of the message that is associated with the event. |\n| `eventType` | `enum (`[ServerEvent.EventType](/business-communications/rcs-business-messaging/reference/rest/v1/ServerEvent.EventType)`)` Type of the event. |\n| `eventId` | `string` A unique event ID assigned for the event instance. |\n| `sendTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Time at which the server sends the event. 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\"`. |"]]
