Method: phones.agentEvents.create

Envía un evento del agente a un usuario.

Los eventos del agente se pueden usar para indicar que el agente leyó un mensaje del usuario o que está escribiendo (lo que agrega un elemento humano a la experiencia de RCS para empresas). Si el usuario no tiene habilitado el RCS, la plataforma de RCS para empresas devuelve un error NOT_FOUND (HTTP 404). Si el usuario tiene habilitados los RCS, pero no se lo puede contactar en el momento, la plataforma devuelve una respuesta 200 OK y controla la entrega según el tipo de evento. Los eventos del agente se ponen en cola en una cola de almacenamiento y reenvío durante un máximo de 30 días y se entregan una vez que el usuario vuelve a estar en línea. Solo los eventos de IS_TYPING son efímeros y no se ponen en cola.

A diferencia de los mensajes del agente, los eventos del agente no se pueden revocar después de enviarse.

Solicitud HTTP

POST https://rcsbusinessmessaging.googleapis.com/v1/{parent=phones/*}/agentEvents

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
parent

string

"phones/{E.164}", donde {E.164} es el número de teléfono del usuario en formato E.164. Por ejemplo, para un usuario con el número de teléfono de EE.UU. +1-222-333-4444, el valor sería phones/+12223334444, y el extremo resultante sería https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentEvents.

Parámetros de consulta

Parámetros
eventId

string

Es el ID del evento, asignado por el agente. Debe ser un UUID, según se define en https://tools.ietf.org/html/rfc4122. La plataforma de RCS for Business ignora cualquier mensaje del agente que se envíe con un ID que se haya usado en un mensaje o evento anterior enviado desde el mismo agente.

agentId

string

Obligatorio. Es el identificador único del agente.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de AgentEvent.

Cuerpo de la respuesta

Si el proceso se realiza de forma correcta, el cuerpo de la respuesta contiene una instancia recién creada de AgentEvent.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/rcsbusinessmessaging

Para obtener más información, consulta OAuth 2.0 Overview.