訊息撤回 API

API 層面支持訊息撤回功能。

調用驗證

詳情參見 REST API 概述的鑑權方式說明。

DELETE v4/push/withdraw/{msg_id}

名稱	是否必選	說明
msg_id	Y	訊息推送返回的msg_id

請求報頭

DELETE /v4/push/withdraw/1828256757 Authorization: Basic (base64 auth string) Accept: application/json

              
              DELETE /v4/push/withdraw/1828256757
 Authorization: Basic (base64 auth string)
 Accept: application/json

此代碼塊在浮窗中顯示

成功返回

< HTTP/1.1 200 OK < Content-Type: application/json { "request_id": "", "msg_id": "1180003" }

              
              < HTTP/1.1 200 OK
< Content-Type: application/json
{
    "request_id": "",
    "msg_id": "1180003"
}

此代碼塊在浮窗中顯示

失敗返回

HTTP/1.1 400 BAD REQUEST Content-Type: application/json; charset=utf-8

              
              HTTP/1.1 400 BAD REQUEST
 Content-Type: application/json; charset=utf-8

此代碼塊在浮窗中顯示

{ "error": { "code": 21003, "message": "Parameter value is invalid,msg_id not exist" } }

              
              {
    "error": {
        "code": 21003,
        "message": "Parameter value is invalid,msg_id not exist"
    }
}

此代碼塊在浮窗中顯示

Code	HTTP	描述	Error Message	詳細解釋
無	200	正確返回	nil	成功狀態碼
21003	400	參數異常	Parameter value is invalid,加上具體的錯誤信息	Parameter value is invalid,加上具體的錯誤信息