Method: phones.agentMessages.delete

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

Jeśli platforma RCS dla firm pomyślnie wycofa wiadomość, zostanie ona usunięta z kolejki wiadomości użytkownika i nigdy nie zostanie dostarczona (200 OK).

Odpowiedź 404 Not Found oznacza, że próba wycofania się nie powiodła, ponieważ wiadomość została dostarczona.

Istnieje niewielkie prawdopodobieństwo, że agent zainicjuje wycofanie, gdy platforma RCS Business Messaging będzie w trakcie dostarczania wiadomości. W takich rzadkich przypadkach agent otrzymuje zdarzenie użytkownika DELIVERED dotyczące wiadomości wkrótce 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 identyfikator wiadomości agenta przypisany przez agenta, który ma zostać wycofany. Na przykład w przypadku amerykańskiego numeru telefonu +1-222-333-4444 i wiadomości od agenta o identyfikatorze „12345xyz” wynikowy punkt końcowy to 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

Jeśli operacja się uda, treść odpowiedzi będzie pustym obiektem JSON.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w sekcji OAuth 2.0 Overview.