Method: phones.agentEvents.create

Envoie un événement de l'agent à un utilisateur.

Les événements de l'agent peuvent être utilisés pour indiquer que l'agent a lu un message de l'utilisateur ou qu'il est en train de taper (ce qui ajoute un élément humain à l'expérience RCS for Business). Si l'utilisateur n'a pas activé le RCS, la plate-forme RCS for Business renvoie une erreur NOT_FOUND (HTTP 404). Si l'utilisateur a activé le RCS, mais qu'il n'est pas joignable pour le moment, la plate-forme renvoie une réponse 200 OK et gère la distribution en fonction du type d'événement. Les événements de l'agent sont mis en file d'attente dans une file d'attente de stockage et de transfert pendant 30 jours maximum, puis envoyés une fois que l'utilisateur se reconnecte. Seuls les événements IS_TYPING sont éphémères et ne sont pas mis en file d'attente.

Contrairement aux messages d'agent, les événements d'agent ne peuvent pas être révoqués après leur envoi.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

"phones/{E.164}", où {E.164} est le numéro de téléphone de l'utilisateur au format E.164. Par exemple, pour un utilisateur dont le numéro de téléphone américain est +1-222-333-4444, la valeur serait phones/+12223334444, et le point de terminaison obtenu serait https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentEvents.

Paramètres de requête

Paramètres
eventId

string

ID de l'événement, attribué par l'agent. Il doit s'agir d'un UUID, tel que défini sur la page https://www.rfc-editor.org/info/rfc9562. La plate-forme RCS for Business ignore tout message d'agent envoyé avec un ID qui a été utilisé par un message ou un événement antérieur envoyé par le même agent.
agentId

string

Obligatoire. Identifiant unique de l'agent.

Corps de la requête

Le corps de la requête contient une instance de AgentEvent.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une nouvelle instance de AgentEvent.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la OAuth 2.0 Overview.