Method: phones.agentMessages.delete

Unieważnia wiadomość agenta, która została wysłana, ale nie została jeszcze dostarczona.

Jeśli platforma RBM anuluje wiadomość, zostanie ona usunięta z kolejki wiadomości użytkownika i nie zostanie dostarczona.

Ta metoda natychmiast zwraca kod 200 OK niezależnie od tego, czy wiadomość została unieważniona czy nie.

Istnieje niewielkie prawdopodobieństwo, że agent zainicjuje anulowanie, gdy platforma RBM jest w trakcie dostarczania wiadomości. W tych rzadkich przypadkach agent otrzymuje zdarzenie DELIVERED związane z wiadomością krótko po zainicjowaniu żądania wycofania.

Żądanie HTTP

DELETE https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*/agentMessages/*}

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

„phones/{E.164}/agentMessages/{messageId}”, gdzie {E.164} to numer telefonu użytkownika w formacie E.164, a {messageId} to przypisany przez agenta identyfikator wiadomości, którą należy unieważnić. Na przykład w przypadku amerykańskiego numeru telefonu +1-222-333-4444 i wiadomości agenta o identyfikatorze „12345xyz” wynikowy punkt końcowy będzie miał postać https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages/12345xyz.

Parametry zapytania

Parametry
agentId

string

Wymagane. Unikalny identyfikator agenta.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi to pusty obiekt JSON.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.