メインコンテンツまでスキップ

Socket Close v2

リクエスト​

DELETE https://api.dmdata.jp/v2/socket/:id

WebSocket v2 に接続中のWebSocketを終了します。

URLパラメータ​

パラメータ名デフォルト説明
:idInteger
WebSocket IDを指定

APIに必要な権限​

  • socket.close

レスポンス​

status: ok​

成功時には何も返しません。

status: error​

APIは各種エラーを次の通り返答します。

{
    "responseId": "66d23c0cede77d82",
    "responseTime": "2021-04-01T00:00:00.000Z",
    "status": "error",
    "error": {
        "message": "...",
        "code": 400
    }
}
フィールド出現説明
errorいつもObject
エラー情報。
error.messageいつもString
エラーメッセージ、標準エラーおよび別表参照。
error.codeいつもInteger
HTTPステータスコード。

標準エラー以外に以下のエラーを出力します。

ステータスコードエラーメッセージ説明
404Socket ID not found.指定された WebSocket ID がない