Revoca un messaggio dell'agente che è stato inviato, ma non ancora consegnato.
Se la piattaforma RBM revoca correttamente un messaggio, il messaggio viene eliminato dalla coda dei messaggi dell'utente e non viene mai recapitato.
Questo metodo restituisce immediatamente 200 OK, indipendentemente dal fatto che il messaggio sia stato revocato o meno.
Esiste una piccola possibilità che l'agente avvii una revoca mentre la piattaforma RBM è in fase di consegna del messaggio. In questi rari casi, l'agente riceve un evento utente DELIVERED per il messaggio poco dopo l'avvio della richiesta di revoca.
Richiesta HTTP
DELETE https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*/agentMessages/*}
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
| Parametri | |
|---|---|
name |
"phones/{E.164}/agentMessages/{messageId}", dove {E.164} è il numero di telefono dell'utente in formato E.164 e {messageId} è l'ID assegnato dall'agente del messaggio dell'agente che deve essere revocato. Ad esempio, con il numero di telefono statunitense +1-222-333-4444 e un messaggio dell'agente con ID "12345xyz", l'endpoint risultante sarà https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages/12345xyz. |
Parametri di query
| Parametri | |
|---|---|
agentId |
Obbligatorio. L'identificatore univoco dell'agente. |
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
In caso di esito positivo, il corpo della risposta è un oggetto JSON vuoto.
Ambiti di autorizzazione
Richiede il seguente ambito OAuth:
https://www.googleapis.com/auth/rcsbusinessmessaging
Per ulteriori informazioni, consulta la sezione OAuth 2.0 Overview.