配信停止アドレス一覧取得

配信停止アドレスの一覧を取得する。開始番号と終了番号を指定する。

開始番号は1以上、登録したアドレスの数までの数値、終了番号は1以上、登録したアドレスの数まで、かつ開始番号より大きい数値となる。

一度に取得可能なアドレス数は1000件まで。

リクエスト

エンドポイント

/v1/cancels?from=[開始番号]&to=[終了番号]

HTTPメソッド

GET

リクエストボディ

なし

レスポンス

ステータスコード
状態
コード
成功 200
クエリパラメータのバリデーションエラー 400
認証失敗 401
存在しないエンドポイント 404
許可されていないHTTPメソッド 405
システムエラーが発生した 500
システムが一時的にサービスを提供できない状態になっている 503
システムのタイムアウト 504
レスポンスボディ
要素名
型
要素数
説明
code 数値 1 ステータスコード
data アドレス型の配列 0:*  

 

アドレス
要素名
型
要素数
説明
address 文字列 1 配信停止アドレス
成功

{"code":200,"data":[{"address":"cancel2@example.com"},{"address":"cancel1@example.com"}]}

失敗

{"code":400,"validation_errors":{"data":"must be difference between from and to less than or equal to 1000"}}