撤消已发送但尚未递送的代理消息。
如果 RBM 平台成功撤消了一条消息,则该消息将从用户的消息队列中删除,且永远不会传送。
无论消息是否成功撤消,此方法都会立即返回 200 OK。
少数情况下,客服人员可能会在 RBM 平台传送消息时发起撤消请求。在这些极少数情况下,代理会在发起撤消请求后不久收到针对消息的 DELIVERED 用户事件。
HTTP 请求
DELETE https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*/agentMessages/*}
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
name |
“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 |
必需。代理的唯一标识符。 |
请求正文
请求正文必须为空。
响应正文
如果成功,则响应正文为空。
授权范围
需要以下 OAuth 作用域:
https://www.googleapis.com/auth/rcsbusinessmessaging
有关详情,请参阅 OAuth 2.0 概览。