GET recipient/(phone)

API情報

管理権限HTTPメソッドAPI名/(サブAPI名)目的
不要GETrecipient/(phone)通知先電話情報の取得
  • 指定した通知先電話情報を取得します。
  • PhoneRecipient.PhoneNumberは国際電話形式でレスポンスが返ります。
    • PhoneRecipient.CountryCodeが"JPN"の場合は、先頭の 0 は除外されます。
      (電話番号が"090XXXXXXXX"の場合、"90XXXXXXXX"と表示されます)
    • PhoneRecipient.CountryCodeが"USA"の場合は、地域番号から出力されます。
      (電話番号が"XXXXXXX"、地域番号が"212"の場合、"212XXXXXXX"と表示されます)

個別パラメータ

URL
フィールド
タイプ
必須
意味
DoServiceCodeString

DNSアウトソースサービスのサービスコード

DowOptionCodeStringサイトフェイルオーバーオプションのサービスコード
ZoneNameString操作対象のゾーン名 (例: example.jp)
PhoneRecipientIdString通知先電話情報のID
  • 操作対象のゾーン名は、GET zonesで取得した文字列を指定してください。
HTTPリクエストボディ
  • なし

レスポンス

フィールド
タイプ
意味
PhoneRecipientHash通知先電話情報のハッシュ
PhoneRecipient.PhoneRecipientIdString

通知先電話情報のID

PhoneRecipient.PhoneNumberString通知先電話番号
PhoneRecipient.CountryCodeString国別コード (例: JPN)
PhoneRecipient.LanguageString言語 (例: JP)

エラーコード

エラー
 
ErrorType
ErrorMessage
説明
備考
パラメータエラー200
ParameterErrorThere are invalid parameters.

以下のパラメータの形式が不正

  • DoServiceCode
  • DowOptionCode
  • ZoneName
 
リソースエラー 200 ResourceNotExistResource is not found.

以下いずれかのリソースが存在しない

  • 契約情報
  • オプション情報
  • ゾーン 
  • 通知先電話情報

 

UnrelateErrorResource is unrelated to other resources.

以下それぞれのリソースの組み合わせが正しくない

  • 契約情報
  • オプション情報
  • ゾーン 
 

制限

  • 契約外のゾーン情報は取得できません。

サンプル

リクエスト

GET /r/(APIVersion)/(DoServiceCode)/(DowOptionCode)/(ZoneName)/recipient/phone/(PhoneRecipientId).json HTTP/1.1
Host: do.api.iij.jp
Date: Mon, 20 Jan 2014 12:34:56 GMT
x-iijapi-Expire: (Expire)
x-iijapi-SignatureMethod: (SignatureMethod)
x-iijapi-SignatureVersion: (SignatureVersion)
Authorization: IIJAPI (AccessKeyId):(Signature)

レスポンスボディ

JSON
{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "PhoneRecipient": {
        "PhoneRecipientId": "12",
        "PhoneNumber": "90XXXXXXXX",
        "CountryCode": "JPN",
        "Language": "JP"
    }
}