Envoyer des événements

Votre agent envoie des événements d'état à l'appareil de l'utilisateur pour simuler des interactions humaines. Pour les utilisateurs, ces événements s'affichent sous forme de confirmations de lecture ou d'indicateurs de saisie, ce qui leur assure que leurs messages sont en cours de traitement.

Pour obtenir la liste complète des options de mise en forme et des valeurs, consultez la documentation de référence sur phones.agentEvents.

Pour en savoir plus sur les événements de webhook que votre agent reçoit de la plate-forme RBM, consultez Recevoir des événements.

L'agent envoie un événement READ.

Pour les utilisateurs, cet événement apparaît comme un accusé de lecture pour un message spécifique. Il indique à l'utilisateur que la plate-forme RBM a transmis son message et que l'agent est en train de le traiter.

Le code suivant envoie un événement READ pour un message avec un messageId correspondant.

cURL

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentEvents?eventId=EVENT_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d "{
  'eventType': 'READ',
  'messageId': 'MESSAGE_ID'
}"

Node.js

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Send the device an event to indicate that messageId has been read
rbmApiHelper.sendReadMessage('[phone]', messageId);

Ce code est un extrait d'un exemple d'agent RBM.

Java

import com.google.rbm.RbmApiHelper;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper();

// Send the device an event to indicate that messageId has been read
rbmApiHelper.sendReadMessage(messageId, "[phone]");

Ce code est un extrait d'un exemple d'agent RBM.

Python

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service

# Send the device an event to indicate that message_id was read
rbm_service.send_read_event('[phone]', message_id)

Ce code est un extrait d'un exemple d'agent RBM.

C#

using RCSBusinessMessaging;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                                 projectId);

// Send the device an event to indicate that messageId has been read
rbmApiHelper.SendReadMessage(messageId, "[phone]");

Ce code est un extrait d'un exemple d'agent RBM.

L'agent envoie un événement IS_TYPING.

Pour les utilisateurs, cet événement apparaît sous la forme d'un indicateur de saisie et leur indique que votre agent est en train de rédiger un message. L'indicateur de saisie expire au bout d'un court laps de temps (environ 20 secondes) ou lorsque l'appareil de l'utilisateur reçoit un nouveau message de votre agent. Votre agent peut envoyer plusieurs événements IS_TYPING pour réinitialiser le minuteur d'expiration de l'indicateur de saisie.

Le code suivant envoie un événement IS_TYPING.

cURL

curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentEvents?eventId=EVENT_ID&agentId=AGENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/rcs-business-messaging" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \
-d "{
  'eventType': 'IS_TYPING',
}"

Node.js

// Reference to RBM API helper
const rbmApiHelper = require('@google/rcsbusinessmessaging');

// Send the device an event to indicate that the agent is typing
rbmApiHelper.sendIsTypingMessage('[phone]', function() {
    console.log('Typing event sent!');
});

Ce code est un extrait d'un exemple d'agent RBM.

Java

import com.google.rbm.RbmApiHelper;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper();

// Send the device an event to indicate that the agent is typing
rbmApiHelper.sendIsTypingMessage("[phone]");

Ce code est un extrait d'un exemple d'agent RBM.

Python

# Reference to RBM Python client helper and messaging object structure
from rcs_business_messaging import rbm_service

# Send the device an event to indicate that the agent is typing
rbm_service.send_is_typing_event('[phone]')

Ce code est un extrait d'un exemple d'agent RBM.

C#

using RCSBusinessMessaging;
…

// Create an instance of the RBM API helper
RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation,
                                                 projectId);

// Send the device an event to indicate that the agent is typing
rbmApiHelper.SendIsTypingMessage(messageId, "[phone]");

Ce code est un extrait d'un exemple d'agent RBM.