发送撤回消息
消息用途
当Chatbot已发送消息到5G消息云服务平台后,希望将发往5G消息云服务平台的消息撤回时,调用此接口进行消息撤回操作。
方法
- HTTPs:put
- URL: https://{serverRoot}/v2/{chatbotAddress}/{messageId}/outbound
- Basepath: messaging
消息关键参数
发送消息URL关键字段 (其他字段见 接口消息URL关键字段)
序号 |
字段 |
数据类型 |
可选属性 |
描述 |
---|---|---|---|---|
HTTP URL 部分(遵循RFC2616) |
||||
1 |
messageId |
String |
M |
待撤回消息的ID。 |
序号 |
字段 |
数据类型 |
可选属性 |
描述 |
---|---|---|---|---|
1 |
serverRoot |
string |
M |
服务器基础URL: hostname(或ip)+port+base path Port和base path可选 例: ip:port/openchatbot |
2 |
apiVersion |
string |
M |
客户端想使用的API版本号. 例: “v2”. |
3 |
chatbotAddress |
string |
M |
行业消息的统一服务地址,客户端可根据此地址将所有通知集合展现。 chatbotAddress是5G云服务平台分配给购买者的chatbotID。如果您已经购买了5G消息应用资产,则可以登录消费者门户,选择”应用管理”查看chatbotID。 |
发送消息HTTP头关键字段
序号 |
字段 |
数据类型 |
可选属性 |
描述 |
---|---|---|---|---|
HTTP 消息头部分(遵循RFC2616) |
||||
1 |
Address |
string |
M |
接受方地址Request-URI |
消息上报通知消息关键字段
序号 |
字段 |
数据类型 |
可选属性 |
描述 |
---|---|---|---|---|
HTTP 消息体 部分(遵循RFC2616) |
||||
1 |
status |
ENUM |
M |
值RevokeRequested,请求撤回消息 |
2 |
address |
string |
M |
源消息接收方地址。 |
发送撤回消息示例
PUT /messaging/v2/sip:888.chatbot@botplatform.rcs.chinamobile.com/22ed8552-e5d2-11ea-b483-fa163e6a8a4e/outbound HTTP/1.1 Content-Type: application/json Authorization:Username="a20a9716-8577-4e5e-8333-490df5b72e9f", Password=“******” Address: tel:+8619585550104 Cache-Control: no-cache Pragma: no-cache Host: 10.120.207.128:8319 Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2 Connection: keep-alive Content-Length: 319 { "address":"tel:+8619585550104", "status":"RevokeRequested" }
发送撤回消息响应
HTTP/1.1 204 No Content Date: Thu, 04 Jun 2009 02:51:59 GMT