Method: phones.agentMessages.delete

Anuluje wiadomość agenta, która została wysłana, ale jeszcze niedostarczona.

Jeśli platforma RBM pomyślnie 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 anulowana.

Istnieje niewielkie ryzyko, że agent może zainicjować unieważnienie, gdy platforma RBM jest w trakcie dostarczania wiadomości. W tych rzadkich przypadkach tuż po zainicjowaniu prośby o unieważnienie agent otrzymuje zdarzenie użytkownika DELIVERED dla wiadomości.

Żą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 przypisany przez agenta do wiadomości agenta, która powinna zostać unieważniona. Jeśli na przykład masz w Stanach Zjednoczonych numer telefonu +1-222-333-4444 i wiadomość agenta o identyfikatorze „12345xyz”, wygenerowanym punktem końcowym będzie https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages/12345xyz.

Parametry zapytania

Parametry
agentId

string

To pole jest wymagane. Unikalny identyfikator agenta.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie pusta.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.