Method: phones.agentEvents.create

Envia um evento do agente para um usuário.

Os eventos do agente podem ser usados para indicar que o agente leu uma mensagem do usuário ou que está digitando (o que adiciona um elemento humano à experiência do RCS for Business). Se o usuário não tiver o RCS ativado, a plataforma do RCS for Business vai retornar um erro NOT_FOUND (HTTP 404). Se o usuário tiver o RCS ativado, mas não puder ser contatado no momento, a plataforma vai retornar uma resposta 200 OK e processar a entrega com base no tipo de evento. Os eventos do agente são colocados em uma fila de armazenamento e encaminhamento por até 30 dias e entregues quando o usuário volta a ficar on-line. Somente os eventos IS_TYPING são temporários e não são colocados em fila.

Ao contrário das mensagens do agente, os eventos do agente não podem ser revogados após o envio.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

"phones/{E.164}", em que {E.164} é o número de telefone do usuário no formato E.164. Por exemplo, para um usuário com o número de telefone dos EUA +1-222-333-4444, o valor seria phones/+12223334444, e o endpoint resultante seria https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentEvents.

Parâmetros de consulta

Parâmetros
eventId

string

O ID do evento, atribuído pelo agente. Precisa ser um UUID, conforme definido em https://www.rfc-editor.org/info/rfc9562. A plataforma do RCS for Business ignora qualquer mensagem de agente enviada com um ID que foi usado por uma mensagem ou evento anterior enviado pelo mesmo agente.

agentId

string

Obrigatório. O identificador exclusivo do agente.

Corpo da solicitação

O corpo da solicitação contém uma instância de AgentEvent.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta incluirá uma instância de AgentEvent.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.