Method: phones.agentMessages.delete

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

如果 RBM 平台成功撤銷訊息，該訊息就會從使用者訊息佇列中刪除，並且永遠不會傳送。

無論訊息是否成功撤銷，此方法會立即傳回 200 OK。

在 RBM 平台在傳送訊息期間，代理程式偶爾可能提出撤銷要求。在這種極少數的情況下，服務專員在啟動撤銷要求後不久，就會收到訊息的「送達」使用者事件。

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。