Révoque un message d'agent qui a été envoyé, mais pas encore distribué.
Si la plate-forme RBM révoque un message avec succès, le message est supprimé de la file d'attente de messages de l'utilisateur et n'est jamais distribué.
Cette méthode renvoie immédiatement 200 OK, que le message ait bien été révoqué ou non.
Il est possible que l'agent lance une révocation pendant que la plate-forme RBM est en train de transmettre le message. Dans ces rares cas, l'agent reçoit un événement utilisateur DELIVERED pour le message peu de temps après le lancement de la demande de révocation.
Requête HTTP
DELETE https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*/agentMessages/*}
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
name |
"phones/{E.164}/agentMessages/{messageId}", où {E.164} est le numéro de téléphone de l'utilisateur au format E.164 et {messageId} est l'ID attribué par l'agent pour le message d'agent qui doit être révoqué. Par exemple, avec le numéro de téléphone américain +1-222-333-4444 et un message d'agent portant l'ID "12345xyz", le point de terminaison obtenu serait https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages/12345xyz. |
Paramètres de requête
Paramètres | |
---|---|
agentId |
Obligatoire. Identifiant unique de l'agent. |
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse est un objet JSON vide.
Champs d'application des autorisations
Requiert le niveau d'accès OAuth suivant :
https://www.googleapis.com/auth/rcsbusinessmessaging
Pour en savoir plus, consultez OAuth 2.0 Overview.