ドメイン管理機能

ドメイン一覧取得

配信実績取得

登録済みのドメインの一覧を取得します。

メソッドとURL

メソッド URL
GET https://{HOST名}/domain?d=domain

リクエスト

URLパラメーター

項目 説明
d 取得するドメインを１件指定する。未指定の場合、登録済みの全件を取得。

レスポンス

ステータスコード

コード メッセージ 説明
200 OK リクエスト受付、正常終了。
500 Internal Server Error 想定外のエラー。
しばらく経ってから再度実施し、状況が改善しなければ、弊社までお問い合わせください。

上記以外のステータスコードが返却される場合もあります。
その場合は、RFC2616規定のHTTPレスポンスステータスコード一覧をご確認ください。

HTTPレスポンスステータスコード一覧

 

ボディーパラメーター

 

項目 型 説明
items Object Array レスポンス情報が設定されます。
domain String 対象のドメイン。
dns Object DNSに関する項目。
status String 登録済みのドメインがDNSに登録されていることの確認結果。
MXレコードおよびAレコード（AAAAレコードも対象）が設定されているかを確認しています。　　　　返却値は”OK”または”NG”。
spf Object spfに関する項目。
status String spf情報がDNSに登録されていることの確認結果。　返却値は”OK”または”NG”。
record String spfレコードの登録内容。
dkim Object Array DKIMに関する項目。selector毎に複数の情報が返却可能。
selector String DKIM情報を識別するためのセレクタ。
status String DKIM情報がDNSに登録されていることの確認結果。返却値は”OK”または”NG”。
key_len Number 鍵生成時のキー長。
start_date String 対象セレクタの利用開始日時。
default Number 第三者署名として利用可能とする指定。
enable Boolean 対象セレクタの利用有効フラグ。
setting_values Object DNSにDKIM情報を設定する際に利用するデータ。

setting_values(DKIMドメイン登録)
fqdn String 作成した公開鍵を登録するFQDN。
type String レコードタイプ。
value String 作成した公開鍵のデータ。オプションなども含めた文字列。
regist_date String 登録日時。
count Number itemsに設定されたデータ件数。
total Number 返却できなかったデータを含めた検索結果件数。

各項目のステータスについて

登録されたドメインの情報が、DNSに登録されているかを、システムで定期的に確認しております。
ステータスがNGの項目がありましたら、速やかに設定をご確認の上、配信処理をご利用ください。

注意事項
DNSへの登録が正しく行われていない場合、メールの不達や迷惑メールとして判断される事があります。

サンプル

レスポンス

正常

{
  "items": [
    {
      "domain": "example.com",
      "dns": {
          "status": "OK"
      },
      "spf": {
          "status": "OK",
          "record": "v=spf1 ip4:192.0.2.1 -all"
      },
      "dkim": [
        {
          "selector": "sample0001",
          "status": "OK",
          "key_len": 1024,
          "start_date": "2021-07-01T00:00+09:00",
          "default": 0,
          "enable": true,
          "setting_values": {
            "fqdn": "sample0001._domainkey.example.com",
            "type": "TXT",
            "value": "v=DKIM1; g=*; k=rsa; p=MIGfMA0GCSqGSIb3...<省略>"
          }
          "regist_date": "2021-07-01T00:00:00+09:00"
        }
      ]
    }
  ],
  "count": 1,
  "total": 1
}

エラー

{
 "message": "Internal Server Error"
}

補足情報が返却されます。