Отменяет сообщение агента, которое было отправлено, но еще не доставлено.
Если платформа RBM успешно отзывает сообщение, оно удаляется из очереди сообщений пользователя и никогда не доставляется.
Этот метод немедленно возвращает 200 OK независимо от того, было ли сообщение успешно отозвано.
Существует небольшая вероятность того, что агент может инициировать отзыв, пока платформа RBM находится в процессе доставки сообщения. В этих редких случаях агент получает пользовательское событие DELIVERED для сообщения вскоре после инициирования запроса на отзыв.
HTTP-запрос
DELETE https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*/agentMessages/*}
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
name | "phones/{E.164}/agentMessages/{messageId}", где {E.164} — номер телефона пользователя в формате E.164, а {messageId} — назначенный агентом идентификатор сообщения агента, которое следует отозвать. . Например, с номером телефона в США +1-222-333-4444 и сообщением агента с идентификатором "12345xyz" результирующая конечная точка будет https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages . /12345xyz . |
Параметры запроса
Параметры | |
---|---|
agentId | Необходимый. Уникальный идентификатор агента. |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа пустое.
Области авторизации
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/rcsbusinessmessaging
Дополнительную информацию см. в обзоре OAuth 2.0 .