Method: phones.agentMessages.delete

撤銷已傳送但尚未送達的服務專員訊息。

如果 RCS for Business 平台成功撤銷訊息，該訊息就會從使用者的訊息佇列中刪除，且永遠不會傳送 (200 OK)。

如果收到 404 Not Found 回應，表示訊息已傳送，因此撤銷嘗試失敗。

在 RCS Business Messaging 平台傳送訊息的過程中，服務專員可能會啟動撤銷程序，但這種情況很少發生。在這些極少數情況下，代理程式會在啟動撤銷要求後不久，收到訊息的 DELIVERED 使用者事件。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

「phones/{E.164}/agentMessages/{messageId}」，其中 {E.164} 是使用者電話號碼的 E.164 格式，{messageId} 則是應撤銷的訊息代理程式指派 ID。舉例來說，如果美國電話號碼為 +1-222-333-4444，且代理商訊息的 ID 為「12345xyz」，則產生的端點會是 https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages/12345xyz。

查詢參數

參數
agentId

string

必要欄位。代理程式的專屬 ID。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會是空白的 JSON 物件。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱OAuth 2.0 Overview。