メッセージリコール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": "パラメーター値が無効です、msg_idが存在しません" } }

              
              {
    "error": {
        "code": 21003,
        "message": "パラメーター値が無効です、msg_idが存在しません"
    }
}

このコードブロックはフローティングウィンドウ内に表示されます

コード	HTTP	説明	エラーメッセージ	詳細な説明
None	200	正常に返されました	nil	成功ステータスコード
21003	400	パラメーターエラー	パラメーター値が無効で、具体的なエラー情報が含まれます	パラメーター値が無効で、具体的なエラー情報が含まれます