POST recipient/(phone)

API情報

管理権限HTTPメソッドAPI名/(サブAPI名)目的
不要POSTrecipient/(phone)通知先電話情報の追加
  • 通知先電話番号を追加します。
  • PhoneNumberは国際電話形式での入力となります。
    • CountryCodeが"JPN"の場合は、先頭の 0 を除外し入力してください。
      (電話番号が"090XXXXXXXX"の場合、"90XXXXXXXX"と入力してください)
    • CountryCodeが"USA"の場合は、地域番号から入力してください。
      (電話番号が"XXXXXXX"、地域番号が"212"の場合、"212XXXXXXX"と入力してください)

個別パラメータ

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

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

DowOptionCodeStringサイトフェイルオーバーオプションのサービスコード
ZoneNameString操作対象のゾーン名 (例: example.jp)
  • 操作対象のゾーン名は、GET zonesで取得した文字列を指定してください。
HTTPリクエストボディ
フィールド
タイプ
必須
意味
PhoneNumberString通知先電話番号
CountryCodeString国別コード (例: JPN)
LanguageString言語 (例: JP)

レスポンス

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

通知先電話情報のID

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

 

 

エラーコード

エラーHTTP Status CodeErrorTypeErrorMessage説明備考
パラメータエラー200
ParameterErrorThere are invalid parameters.

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

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

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

  • 契約情報
  • オプション情報
  • ゾーン
 
ResourceAlreadyExistResource is found.

以下リソースがすでに存在している

  • 通知先電話情報
 
UnrelateErrorResource is unrelated to other resources.

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

  • 契約情報
  • オプション情報
  • ゾーン 
 
UpperLimitErrorAn upper limit value exists.

以下のリソースが上限数存在している

  • 通知先電話情報
 

制限

  • 契約外のゾーンに対する操作は実行できません。

サンプル

リクエスト

POST /r/(APIVersion)/(DoServiceCode)/(DowOptionCode)/(ZoneName)/recipient/phone.json HTTP/1.1
Host: do.api.iij.jp
Content-Type: application/json
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)
  
{
    "PhoneNumber": "90XXXXXXXX",
    "CountryCode": "JPN",
    "Language": "JP"
}

レスポンスボディ

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