域名

域API命令列表

我们的API是专为效率而建的高级域名管理和获取工具包。 在Dynadot平台上有超过50个命令可供设置、管理、注册和竞标,您可以完全控制您的帐户和域设置在任何API软件上。 我们的域API对所有帐户开放,所以赶快开始吧!

现在就开始使用高级域名API吧!

我们的高级域API请求发送到以下URL:

https://api.dynadot.com/api3.xml

请求应通过https(安全套接字)发送以确保安全。 请求应具有以下两个参数,一个“密钥”和一个“命令”。 可以单击每个命令以查看与其关联的参数。

您将根据您的账户价格档次收到不同的线程计数: 价格档次 账户 常规 1个线程 批量 5个线程 超大批量 25个线程 高级批量 25个线程


 
请求参数
解释
KeyAPI访问密钥可在Dynadot帐户控制面板的“工具”->“API”侧边栏菜单下找到。
Command
Domain:
search, register, delete, renew, push, transfer, bulk_register

domain_info, set_whois, set_ns, set_parking, set_forwarding, set_stealth, set_hosting, set_dns2, set_email_forward, set_clear_domain_setting, set_folder, set_note, set_renew_option, set_privacy, tld_price, list_domain, lock_domain, set_dnssec

cancel_transfer, get_transfer_status, set_transfer_auth_code, authorize_transfer_away, get_transfer_auth_code

get_domain_push_request, set_domain_push_request
contact:
create_cn_audit, get_cn_audit_status, create_contact, edit_contact, delete_contact, contact_list, get_contact

set_contact_eu_setting, set_contact_lv_setting, set_contact_lt_setting
Nameserver:
get_ns, add_ns, register_ns, set_ns_ip, delete_ns, delete_ns_by_domain, server_list, get_dns
Account:
account_info, get_account_balance, set_default_whois, set_default_ns, set_default_parking, set_default_forwarding, set_default_stealth, set_default_hosting, set_default_dns, set_default_dns2, set_default_email_forward, set_clear_default_setting, set_default_renew_option
Folder:
create_folder, delete_folder, set_folder_whois, set_folder_ns, set_folder_parking, set_folder_forwarding, set_folder_stealth, set_folder_hosting, set_folder_dns, set_folder_dns2, set_folder_email_forward, set_clear_folder_setting, set_folder_name, set_folder_renew_option, folder_list
Aftermarket:
add_backorder_request, delete_backorder_request, backorder_request_list

get_open_auctions, get_auction_details, get_auction_bids, place_auction_bid, get_closed_auctions

get_open_backorder_auctions, get_backorder_auction_details, place_backorder_auction_bid, get_closed_backorder_auctions, get_expired_closeout_domains, buy_expired_closeout_domain, get_listings, get_listing_item, buy_it_now
Other:
set_afternic_confirm_action, set_sedo_confirm_action, order_list, get_order_status, is_processing

XML format. The response you receive should contain 2 or 3 of the following fields:

XML结果标签
解释
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
 

搜索结果

Support multi-thread

如要发送搜索命令,则需包含下面参数:

搜索参数
解释
domain0 - domain99您搜索的域名,常规账户可以每条指令指定1个域名,批量和超级批量账户可以指定多达100个域名
language0 - language99 (可选)各自域名的语言标签,仅用于国际化域名
show_price (可选)如果您想在账户货币中显示价格,请设置为等于“1”
currency (可选)您可以决定货币类型且支持此参数的是"USD"、"CNY"、"GBP"、"EUR"、"INR"、"CAD"等等。如果您没有设定此参数,我们将使用账户的默认货币
XML结果标签
解释
<Results></Results>搜索命令XML响应的根节点
<SearchResponse></SearchResponse>搜索响应标签
<SearchHeader></SearchHeader>搜索标头标签
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<DomainName></DomainName>您刚刚搜索的域名
<Available></Available>如果域名可用
<Price></Price>若您将"show_price"设为等于“1”,且该域名可购,则将告知您相关价格信息
<Language></Language>域名的语言信息
Search Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
Response (XML format)
<Results>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.com</DomainName>
      <Available>yes</Available>
      <Price>77.00 in USD</Price>
    </SearchHeader>
  </SearchResponse>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.net</DomainName>
      <Available>yes</Available>
      <Price>44.00 in USD</Price>
    </SearchHeader>
  </SearchResponse>
</Results>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
Response (JSON format)
{
   "SearchResponse":{
      "ResponseCode":"0",
      "SearchResults":[
         {
            "DomainName":"mydomain.com",
            "Available":"yes",
            "Price":"77.00 in USD"
         },
         {
            "DomainName":"mydomain.net",
            "Available":"yes",
            "Price":"44.00 in USD"
         }
      ]
   }
}
 

注册命令

Support multi-thread

发送注册命令后将创建并处理注册订单。您账户中须由足够余额支付订单。如果发送注册命令,须包含下列参数:

注册请求参数
解释
domain您想注册的域名,每个请求仅可注册1个域名
language (可选)被请求域名的语言标签,仅国际化域名需要
duration注册所需的时长
registrant_contact (可选)您想在域上使用的注册联系人
admin_contact (可选)您想在域上使用的管理员联系人
technical_contact (可选)您想在该域上使用的技术联系人
billing_contact (可选)您希望在域名上使用的账单联系人
option0 (如果必要)
.AT, .BE,注册人姓名
option1 (如果必要).AT, .BE,注册组织(可选)
对于.AT,您可指定为option0, option1,,或两者同时指定
premium (可选)如果您想注册一个高端域名,请将其设置为"1"(可选)
currency (可选)您可以决定货币类型且支持此参数的是"USD"、"CNY"、"GBP"、"EUR"、"INR"、"CAD"等等。如果您没有设定此参数,我们将使用账户的默认货币
coupon (可选)您希望用于此命令的优惠代码
XML结果标签
解释
<RegisterResponse></RegisterResponse>注册响应标签
<RegisterHeader></RegisterHeader>注册标头标签
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<RegisterContent></RegisterContent>注册内容标签
<Expiration></Expiration>以Unix时间计的过期日期(毫秒,自1970年1月1日午夜起),仅结果为"success"时使用
<Registration></Registration>以Unix时间计的注册日期(毫秒,自1970年1月1日午夜起),仅结果为"success"时使用
Register Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=register&domain=domain1.net&duration=3&currency=USD
Response (XML format)
<RegisterResponse>
  <RegisterHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterHeader>
  <RegisterContent>
    <Expiration>1458379145266</Expiration>
  </RegisterContent>
</RegisterResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=register&domain=domain1.net&duration=3&currency=USD
Response (JSON format)
{
   "RegisterResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domain1.net",
      "Expiration":"1458379145266"
   }
}
 

删除命令

Support multi-thread

调用删除(delete)命令将删除仍然处于宽限期中的域名。注册费将退回至您的账户余额。已续期或已移动至新账户的域名不得通过API进行删除。如果调用删除命令,应包括以下参数:

删除请求参数
解释
domain您想删除的域名,每次请求仅可删除1个域名
XML结果标签
解释
<DeleteResponse></DeleteResponse>删除响应标签
<DeleteHeader></DeleteHeader>删除标头标签
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用

删除示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=delete&domain=domain1.com
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteResponse>
  <DeleteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteHeader>
</DeleteResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=delete&domain=domain1.com
Response (JSON format)
{
  "DeleteResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainName": "domain1.com"
  }
}
 

续费命令

Support multi-thread

调用续期(renew)命令将创建和处理续期订单。您必须具备足够的账户余额用于该订单。如果调用续期命令,应包括以下参数:

续费请求参数
解释
domain您想续费的域名,每个请求仅可续费1个域名
duration需要为域名续费多少年
year (可选)域名过期的当前年份
currency (可选)您可以决定货币类型且支持此参数的是"USD"、"CNY"、"GBP"、"EUR"、"INR"、"CAD"等等。如果您没有设定此参数,我们将使用账户的默认货币
price_check (可选)您可以将此参数添加到命令中,查看更新此域名的详细价格信息。注意:添加这个参数到命令中,我们的api将不会更新域名,而只显示价格信息。
coupon (可选)您希望用于此命令的优惠代码
no_renew_if_late_renew_fee_needed (可选)如果域名需要缴纳滞纳费才能续订,则可以将此参数添加到命令中以避免续订。如果域名需要缴纳滞纳费才能续订,并且在命令中传递了“ no_renew_if_late_renew_fee_needed = 1”,则该域名将不会续订。
XML结果标签
解释
<RenewResponse></RenewResponse>续费响应标签,它是响应XML文档的根节点
<RenewHeader></RenewHeader>续费标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<PriceInfo></PriceInfo>价格信息标签,这仅在状态为"price_check_success"时使用
<RenewContent></RenewContent>续费内容标签,仅状态为"success"时使用
<Expiration></Expiration>以Unix时间计的过期日期(毫秒,自1970年1月1日午夜起),仅结果为"success"时使用
Renew Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
Response (XML format)
<RenewResponse>
  <RenewHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RenewHeader>
  <RenewContent>
    <Expiration>73984579834</Expiration>
  </RenewContent>
</RenewResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
Response (JSON format)
{
   "RenewResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domain1.com",
      "Expiration":"73984579834"
   }
}
 

推送指令

Support multi-thread

调用push命令将创建和处理一个push订单。您必须为订单解锁您的域名和帐户。接收人账户必须拒绝/接受域名才能完成订单。如果调用push命令,应包含以下参数:

Push请求参数
解释
domain您想要推送的域名。我们还支持批量推送,您可以使用“;”来分割域名。例子:domain1.com;domain2.com
receiver_push_username输入收件人帐户的用户名
currency (可选)您可以决定货币类型且支持此参数的是"USD"、"CNY"、"GBP"、"EUR"、"INR"、"CAD"等等。如果您没有设定此参数,我们将使用账户的默认货币
unlock_domain_for_push(optional)将此参数设为等于“1”。如果域名被锁定,我们将自动对其解锁,您将无需手动解锁域名
receiver_email(optional)接收方账户的推送电子邮件
XML结果标签
解释
<PushResponse></PushResponse>ush响应标签,这是响应XML文档的根节点
<PushHeader></PushHeader>Push头部
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Push Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
Response (XML format)
<PushResponse>
  <PushHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
  </PushHeader>
</PushResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
Response (JSON format)
{
   "PushResponse":{
      "ResponseCode":"0",
      "Status":"order created"
   }
}
 

转让命令

Support multi-thread

调用转移命令将创建和处理转移订单。部分tld可能会要求失去域名的注册人确认后才能完成订单。如果调用转移命令,应包括以下参数:

转移请求参数
解释
domain您想要转移到Dynadot中的域名,每一次请求只可以转移1个域名
auth转移请求授权代码。
currency (可选)您可以决定货币类型且支持此参数的是"USD"、"CNY"、"GBP"、"EUR"、"INR"、"CAD"等等。如果您没有设定此参数,我们将使用账户的默认货币
registrant_contact (可选)您希望在转移完成后使用的注册联系人。(不是所有TLD都支持此功能)
admin_contact (可选)您希望在转移完成时使用的管理联系人。(不是所有的顶级域都支持此功能)
technical_contact (可选)在转移完成时要使用的技术联系人。(不是所有TLD都支持此功能)
billing_contact (可选)转移完成后要使用的账单联系人。(不是所有TLD都支持此功能)
coupon (可选)您希望用于此命令的优惠代码
XML结果标签
解释
<TransferResponse></TransferResponse>转移响应标签,这是响应XML文档的根节点
<TransferHeader></TransferHeader>转移头部
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Transfer Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
Response (XML format)
<TransferResponse>
  <TransferHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
  </TransferHeader>
</TransferResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
Response (JSON format)
{
   "TransferResponse":{
      "ResponseCode":"0",
      "Status":"order created",
      "DomainName":"domain1.com"
   }
}
 

批量注册命令

Support multi-thread

调用批量注册命令将创建和处理注册订单。您必须有足够的账户余额来支付订单。如果调用批量注册命令,则应包括以下参数:

批量注册请求参数
解释
domain0-domain99您要注册的域名,每次请求最多可注册100个域名
premium (可选)如果您想注册一个高端域名,请将其设置为"1"(可选)
currency (可选)您可以决定货币类型,支持的参数包括"USD"、"CNY"、"GBP"、"EUR"、"INR"、"CAD"等等。如果您遗漏了此参数,我们将使用账户默认货币。
coupon (可选)您希望用于此命令的优惠代码
XML结果标签
解释
<BulkRegisterResponse></BulkRegisterResponse>大量注册响应的标记
<BulkRegisterHeader></BulkRegisterHeader>批量注册标题标记
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<BulkRegisterContent></BulkRegisterContent>批量注册内容的标签
<Expiration></Expiration>以Unix时间计的过期日期(毫秒,自1970年1月1日午夜起),仅结果为"success"时使用
<Result></Result>注册操作的结果
<Message></Message>注册操作的错误消息,仅在结果为"error"时使用

批量注册示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<BulkRegisterResponse>
  <BulkRegisterHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BulkRegisterHeader>
  <BulkRegisterContent>
    <BulkRegister>
      <RegisterResult>
        <DomainName>domain0.com</DomainName>
        <Expiration>1234567890</Expiration>
        <Result>success</Result>
        <Message>-</Message>
      </RegisterResult>
      <RegisterResult>
        <DomainName>domain1.com</DomainName>
        <Expiration>-</Expiration>
        <Result>error</Result>
        <Message>not_available</Message>
      </RegisterResult>
    </BulkRegister>
  </BulkRegisterContent>
</BulkRegisterResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
Response (JSON format)
{
  "BulkRegisterResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BulkRegister": [
      {
        "DomainName": "domain0.com",
        "Expiration": "1234567890",
        "Result": "success",
        "Message": "-"
      },
      {
        "DomainName": "domain1.com",
        "Expiration": "-",
        "Result": "error",
        "Message": "not_available"
      }
    ]
  }
}
 

域名信息命令

Support multi-thread

此命令仅适用于XML和JSON格式:

域名信息请求参数
解释
domain请翻译以下文本为中文简体:Only 1 domain permitted per request
XML结果标签
解释
<DomainInfoResponse></DomainInfoResponse>响应XML文档的根节点
<DomainInfoResponseHeader></DomainInfoResponseHeader>响应标头
<ResponseCode></ResponseCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<DomainInfoContent></DomainInfoContent>响应内容
<Domain></Domain>域名
<Name></Name>域名名称
<Expiration></Expiration>以Unix时间计的域名过期日期(毫秒,自1970年1月1日起)
<Registration></Registration>以Unix时间(自UTC时间1, 1970一月午夜起的毫秒数)表示的域名注册日期
<NameServerSettings></NameServerSettings>域名的域名服务器设置
<Type></Type>域名的域名服务器类型
<WithAds></WithAds>如果您想为域名创建停放页面
<Whois></Whois>Whois信息
<Registrant></Registrant>注册人信息
<ContactId></ContactId>联系方式ID
<Admin></Admin>管理员信息
<Technical></Technical>技术信息
<Billing></Billing>计费信息
<Locked></Locked>是否锁定
<Disabled></Disabled>启用状态
<UdrpLocked></UdrpLocked>UDRP锁定或未锁定
<UdrpLocked></UdrpLocked>UDRP锁定或未锁定
<RegistrantUnverified></RegistrantUnverified>未验证注册人
<Hold></Hold>暂停
<Privacy></Privacy>隐私保护状态
<isForSale></isForSale>销售状态
<RenewOption></RenewOption>续费选项
<Note></Note>备注
<Folder></Folder>文件夹信息
<FolderId></FolderId>文件夹ID
<FolderName></FolderName>文件夹名称
Domain Information Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=domain_info&domain=domain1.com
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<DomainInfoResponse>
  <DomainInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </DomainInfoHeader>
  <DomainInfoContent>
    <Domain>
      <Name>domain1.com</Name>
      <Expiration>1361430589062</Expiration>
      <Registration>1234567890123</Registration>
      <NameServerSettings>
        <Type>Dynadot Parking</Type>
        <WithAds>Yes</WithAds>
      </NameServerSettings>
      <Whois>
        <Registrant>
          <ContactId>0</ContactId>
        </Registrant>
        <Admin>
          <ContactId>0</ContactId>
        </Admin>
        <Technical>
          <ContactId>0</ContactId>
        </Technical>
        <Billing>
          <ContactId>0</ContactId>
        </Billing>
      </Whois>
      <Locked>yes</Locked>
      <Disabled>no</Disabled>
      <UdrpLocked>no</UdrpLocked>
      <RegistrantUnverified>no</RegistrantUnverified>
      <Hold>no</Hold>
      <Privacy>none</Privacy>
      <isForSale>yes</isForSale>
      <RenewOption>no renew option</RenewOption>
      <Note/>
      <Folder>
        <FolderId>-1</FolderId>
        <FolderName>(no folder)</FolderName>
      </Folder>
    </Domain>
  </DomainInfoContent>
</DomainInfoResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=domain_info&domain=domain1.com
Response (JSON format)
{
  "DomainInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainInfo": {
      "Name": "domain1.com",
      "Expiration": "1361430589062",
      "Registration": "1234567890123",
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      },
      "Whois": {
        "Registrant": {
          "ContactId": "0"
        },
        "Admin": {
          "ContactId": "0"
        },
        "Technical": {
          "ContactId": "0"
        },
        "Billing": {
          "ContactId": "0"
        }
      },
      "Locked": "yes",
      "Disabled": "no",
      "UdrpLocked": "no",
      "RegistrantUnverified": "no",
      "Hold": "no",
      "Privacy": "none",
      "isForSale": "yes",
      "RenewOption": "no renew option",
      "Note": "",
      "Folder": {
        "FolderId": "-1",
        "FolderName": "(no folder)"
      }
    }
  }
}
 

设置Whois命令

Support multi-thread

如果设置Whois命令,则应包含以下参数:

设置Whois请求参数
解释
domain您要设置的域名,每个请求仅可设置100个域名,请务必用逗号将其隔开
registrant_contact域名的注册人信息
admin_contact域名管理员信息
technical_contact域名的技术信息
billing_contact域名的计费信息
XML结果标签
解释
<SetWhoisResponse></SetWhoisResponse>响应XML文档的根节点
<SetWhoisHeader></SetWhoisHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Whois Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Response (XML format)
<SetWhoisResponse>
  <SetWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetWhoisHeader>
</SetWhoisResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Response (JSON format)
{
   "SetWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置域名服务器命令

Support multi-thread

如要呼叫设置域名服务器命令,应包含下列参数:

设置域名服务器请求参数
解释
domain您要设置的域名,每个请求仅可设置100个域名,请务必用逗号将其隔开
ns0 - ns12您要设置并启用域名的域名服务器,您可指定多达13个域名服务器,但它们必须已经在您的账户中
XML结果标签
解释
<SetNsResponse></SetNsResponse>设置域名服务器响应标签,它是响应XML文档的根节点
<SetNsHeader></SetNsHeader>设置域名响应标题标签
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用

设置Ns示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetNsResponse>
  <SetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsHeader>
</SetNsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
Response (JSON format)
{
  "SetNsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

设置停放命令

Support multi-thread

如设置停靠命令,则下列参数应包含在内:

设置域名停放请求参数
解释
domain您要设置的域名,每个请求仅可设置100个域名,请务必用逗号将其隔开
with_ads (可选)如果您不要第三方广告,则可将此参数设为"no"
XML结果标签
解释
<SetParkingResponse></SetParkingResponse>设置停放响应的标签,为响应XML文档的根节点
<SetParkingHeader></SetParkingHeader>设置域名停放文件夹标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Parking Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_parking&domain=domain1.com&with_ads=no
Response (XML format)
<SetParkingResponse>
  <SetParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetParkingHeader>
</SetParkingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_parking&domain=domain1.com&with_ads=no
Response (JSON format)
{
   "SetParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置转发命令

Support multi-thread

如果发送设置转发命令,则须包含下列参数

设置转发请求参数
解释
domain您要设置的域名,每个请求仅可设置100个域名,请务必用逗号将其隔开
forward_url您希望域名转发至的URL地址。请注意,参数必须为已编码,以便API调用可得到正确解析。
is_temp (可选)您要跳转域名的跳转状态,默认值为"temporary",,若您要永久跳转,则可将此参数设为"no"
XML结果标签
解释
<SetForwardingResponse></SetForwardingResponse>响应XML文档的根节点
<SetForwardingHeader></SetForwardingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Forwarding Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
Response (XML format)
<SetForwardingResponse>
  <SetForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetForwardingHeader>
</SetForwardingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
Response (JSON format)
{
   "SetForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置隐身命令

Support multi-thread

如果发送设置隐身命令,则须包含下列参数:

设置隐身请求参数
解释
domain您要设置的域名,每个请求仅可设置100个域名,请务必用逗号将其隔开
stealth_url您希望域名转发至的URL地址。请注意,参数必须为已编码,以便API调用可得到正确解析。
stealth_title (可选)页面标题
XML结果标签
解释
<SetStealthResponse></SetStealthResponse>响应XML文档的根节点
<SetStealthHeader></SetStealthHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Stealth Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Response (XML format)
<SetStealthResponse>
  <SetStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetStealthHeader>
</SetStealthResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Response (JSON format)
{
   "SetStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置托管命令

Support multi-thread

如果发送设置托管命令,则须包含下列参数:

设置托管请求参数
解释
domain您要设置的域名,每个请求仅可设置100个域名,请务必用逗号将其隔开
hosting_type您想要的托管类型,可选择"advanced"和"basic"
mobile_view_on仅当hosting_type为"advanced",时刻将此参数设为"yes"
XML结果标签
解释
<SetHostingResponse></SetHostingResponse>响应XML文档的根节点
<SetHostingHeader></SetHostingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Hosting Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
Response (XML format)
<SetHostingResponse>
  <SetHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetHostingHeader>
</SetHostingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
Response (JSON format)
{
   "SetHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置DNS2命令

Support multi-thread

如果调用设置DNS2命令,应包含以下参数:

请注意,调用set DNS2命令将覆盖当前DNS设置。

设置DNS2请求参数
解释
domain您要设置的域名,每个请求仅可设置100个域名,请务必用逗号将其隔开
main_record_type0 - main_record_type19 (optional)主记录类型应为"a"、"aaaa"、"cname"、"forward"、"txt"、"mx"、"stealth"、"email"
main_record0 - main_record19为您的域名指定DNS记录
main_recordx0 - main_recordx19Mx距离、转发类型(301为“1”,302为“2”),隐形转发标题或电子邮件别名,当main_record_type为"forward"、"mx"、"stealth"、"email"时为必需。
subdomain0 - subdomain99 (可选)Subdomain records (可选)
sub_record_type0 - sub_record_type99子域名记录类型应为"a"、"aaaa"、"cname"、"forward"、"txt"、"srv"、"mx"、"stealth"、"email"
sub_record0 - sub_record99子域名IP地址或目标主机
sub_recordx0 - sub_recordx99Mx距离、转发类型、隐形转发标题或电子邮件别名当sub_record_type为"forward"、"mx"、"stealth"、"email"时必须提供
ttl (可选)生存时间
add_dns_to_current_setting (可选)如果您想将新的DNS设置附加到现有的DNS设置中,请将其设置为“1”(可选)
XML结果标签
解释
<SetDnsResponse></SetDnsResponse>响应XML文档的根节点
<SetDnsHeader></SetDnsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set DNS2 Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnsResponse>
  <SetDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnsHeader>
</SetDnsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1
Response (JSON format)
{
  "SetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

设置 DNSSEC 命仕

Support multi-thread

调用设置 Dnssec 命令将设定域名的 DNSSEC。此命令仅支持 XML 和 JSON 格式。如果调用此命令,应包含以下参数:

您可以根据您的域名选择填写Option中相应的参数值。

选项1:domainName,keyTag,digestType,digest,Algorithm

选项2:域名,标志,公钥,算法

注意事项:请根据需要选择与标签相对应的数字作为您的参数值。

设置 DNSSEC 请求参数
解释
domainName您需要设置dnssec的域名
keyTag关键标签
digestType您可以从以下列表中选择一个数字来代表您的数字签名类型: SHA-1(1) SHA-256(2) GOSTR 34.11-94(3) SHA-384(4)
digestDigest.
Algorithm您可以从以下列表中选择一个数字来表示您的数字签名算法: RSA/MD5(1) Diffie-Hellman(2) DSA/SHA-1(3) 椭圆曲线(4) RSA/SHA-1(5) DSA-NSEC3-SHA1(6) RSASHA1-NSEC3-SHA1(7) RSA/SHA-256(8) RSA/SHA-512(10) GOSTR 34.10-2001(12) ECDSA Curve P-256 with SHA-256(13) ECDSA Curve P-384 with SHA-384(14) ED25519(15) ED448(16) 间接(252) 私有DNS(253) 私有OID(254)
flags您可以从以下列表中选择一个数字来代表您的数字签名符号:ZSK(256)KSK(257)
publicKey公钥必须为base64编码。
XML结果标签
解释
<SetDomainDnssecResponse></SetDomainDnssecResponse>响应的根节点
<SetDomainDnssecHeader></SetDomainDnssecHeader>设置 Dnssec 头部
<ResponseCode></ResponseCode>如果操作成功,则为成功的"0",失败的"-1"
<Status></Status>请求状态
<Error></Error>请求的错误信息仅在状态为“错误”时使用

设置 Dnssec 示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_domain_dnssec&domainName=domain-haha1.com&flags=257&publicKey=123&algorithm=1
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetDomainDnssecResponse>
  <SetDomainDnssecHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetDomainDnssecHeader>
  <SetDomainDnssecContent/>
</SetDomainDnssecResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_domain_dnssec&domainName=domain-haha1.com&flags=257&publicKey=123&algorithm=1
Response (JSON format)
{
  "SetDomainDnssecResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

设置电子邮件转发命令

Support multi-thread

如果发送设置电子邮件转发命令,则须包含下列参数:

设置电子邮件转发请求参数
解释
domain您要设置的域名,每个请求仅可设置100个域名,请务必用逗号将其隔开
forward_type转发类型,可以是"donot"::不要转发邮件;"mx":将邮件转发给另一个邮箱主机(MX记录);"forward"::将邮件转发给另一个邮箱主机
username0 - username9用户名,仅"forward_type"为"forward"时使用
exist_email0 - exist_email9现有电子邮箱地址,仅当"forward_type"为"forward"时使用
mx_host0 - mx_host2邮箱主机,仅"forward_type"为"mx"时使用
mx_distance0 - mx_distance2Distance0为最高优先级,仅当"forward_type"为"mx"时使用
XML结果标签
解释
<SetEmailForwardingResponse></SetEmailForwardingResponse>响应XML文档的根节点
<SetEmailForwardingHeader></SetEmailForwardingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Email Forward Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
Response (XML format)
<SetEmailForwardingResponse>
  <SetEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetEmailForwardingHeader>
</SetEmailForwardingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
Response (JSON format)
{
   "SetEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置清除域名设置命令

Support multi-thread

如果发送设置清除域名设置命令,则须包含下列参数:

设置清除域名设置请求参数
解释
domain您要设置的域名,每个请求仅可设置100个域名,请务必用逗号将其隔开
service您要清除的服务,它可以是“转发”、“隐形”、“电子邮件转发”、“dns”和“名字服务器”
XML结果标签
解释
<SetClearDomainSettingResponse></SetClearDomainSettingResponse>响应XML文档的根节点
<SetClearDomainSettingHeader></SetClearDomainSettingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Clear Domain Setting Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Response (XML format)
<SetClearDomainSettingResponse>
  <SetClearDomainSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDomainSettingHeader>
</SetClearDomainSettingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Response (JSON format)
{
   "SetClearDomainSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹命令

Support multi-thread

如果发送设置文件夹命令,则须包含下列参数:

设置文件夹请求参数
解释
domain要更新的域名,每次请求仅可设置1个域名
folder您要将域名移动至的文件夹名称,若要将域名已从至默认文件夹,则可将文件夹名设置为"Default"。文件夹名区分大小写,例如,"Folder1"和"folder1"是两个不同的文件夹名
folder_id (可选)您要将域名移动至的文件夹ID
XML结果标签
解释
<SetFolderResponse></SetFolderResponse>设置文件夹响应标签,它是响应XML文档的根节点
<SetFolderHeader></SetFolderHeader>设置文件夹标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Folder Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder&domain=domian1.com&folder=folder1
Response (XML format)
<SetFolderResponse>
  <SetFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHeader>
</SetFolderResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder&domain=domian1.com&folder=folder1
Response (JSON format)
{
   "SetFolderResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置注释命令

Support multi-thread

如果发送设置注释命令,则须包含下列参数:

设置通知请求参数
解释
domain您想设置的域名,每个请求仅可设置1个域名
note您想为域名设置的注释,可以为空
XML结果标签
解释
<SetNoteResponse></SetNoteResponse>响应XML文档的根节点
<SetNoteHeader></SetNoteHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Note Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
Response (XML format)
<SetNoteResponse>
  <SetNoteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNoteHeader>
</SetNoteResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
Response (JSON format)
{
   "SetNoteResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置客户编号命令(仅限经销商)

Support multi-thread

如果调用设置客户ID命令,则应包含以下参数:

设置客户ID请求参数
解释
domain您想设置的域名 , 按逗号分隔多个域名 ( Max :100 )
customer_id要设置到域的客户 ID 不能为空
XML结果标签
解释
<SetCustomerIdResponse></SetCustomerIdResponse>响应XML文档的根节点
<SetCustomerIdHeader></SetCustomerIdHeader>响应标头
<SetCustomerIdContent></SetCustomerIdContent>响应内容
<SetCustomerIdSuccess></SetCustomerIdSuccess>设置客户ID成功响应内容
<SetCustomerIdFailed></SetCustomerIdFailed>设置客户编号失败的响应内容
<ResponseCode></ResponseCode>如果操作成功,"0" 表示成功,"-1" 表示失败,"1" 表示问题
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Customer Id Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_customer_id&domain=domain1.com,domain2.com&customer_id=123456
Response (XML format)
<SetCustomerIdResponse>
    <SetCustomerIdHeader>
        <ResponseCode>0</ResponseCode>
        <Status>success</Status>
    </SetCustomerIdHeader>
    <SetCustomerIdContent>
        <SetCustomerIdSuccess>
            <content>
                <Domain>domain1.com</Domain>
                <CustomerId>123456</CustomerId>
            </content>
            <content>
                <Domain>domain2.com</Domain>
                <CustomerId>123456</CustomerId>
            </content>
        </SetCustomerIdSuccess>
    </SetCustomerIdContent>
</SetCustomerIdResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_customer_id&domain=domain1.com,domain2.com&customer_id=123456
Response (JSON format)
{
    "SetCustomerIdResponse": {
        "ResponseCode": 0,
        "Status": "success",
        "SetCustomerIdSuccess": [
            {
                "Domain": "domain1.com",
                "CustomerId": 123456
            },
            {
                "Domain": "domain2.com",
                "CustomerId": 123456
            }
        ]
    }
}
 

设置续费选项

Support multi-thread

如果发送设置续费选项命令,则须包含下列参数:

设置续费选项请求参数
解释
domain您要设置的域名,每个请求仅可设置100个域名,请务必用逗号将其隔开
renew_option可以是"donot", "auto", "reset"
XML结果标签
解释
<SetRenewOptionResponse></SetRenewOptionResponse>响应XML文档的根节点
<SetRenewOptionHeader></SetRenewOptionHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用

设置续费选项示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetRenewOptionResponse>
  <SetRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetRenewOptionHeader>
</SetRenewOptionResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
Response (JSON format)
{
  "SetRenewOptionResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

设置隐私保护命令

Support multi-thread

如果发送设置隐私保护命令,则须包含下列参数:

设置隐私保护请求参数
解释
domain您要设置的域名,每个请求仅可设置100个域名,请务必用逗号将其隔开
option您想为域名设置的隐私状态,可以是"full", "partial",或者"off"
XML结果标签
解释
<SetPrivacyResponse></SetPrivacyResponse>响应XML文档的根节点
<SetPrivacyHeader></SetPrivacyHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Privacy Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_privacy&domain=domain1.com&option=off
Response (XML format)
<SetPrivacyResponse>
  <SetPrivacyHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetPrivacyHeader>
</SetPrivacyResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_privacy&domain=domain1.com&option=off
Response (JSON format)
{
   "SetPrivacyResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

TLD价格

Support multi-thread

此功能仅在XML和JSON格式中可用:

Tld价格请求参数
解释
currency (可选)返回结果的货币,它应该是"usd", "eur", 或 "cny",默认货币是账户设置的Api默认货币
count_per_page (optional)每页显示多少个实体
page_index (optional)你想查看哪个页面的实体?
sort (optional)请从以下选项中选择一个作为排序参数的值:
* 如果您未选择,我们将使用默认排序。
1) RankAsc (默认)
2) RankDesc
3) NameAsc
4) NameDesc
5) SalesAsc
6) SalesDesc
7) LaunchDateAsc
8) LaunchDateDesc
9) CountAsc
10) CountDesc
11) RegistryAsc
12) RegistryDesc
13) SaleEndDateAsc
14) SaleEndDateDesc
15) PriceAsc
16) PriceDesc
17) BulkPriceAsc
18) BulkPriceDesc
19) SuperBulkPriceAsc
20) SuperBulkDateDesc
XML结果标签
解释
<TldPriceResponse></TldPriceResponse>响应XML文档的根节点
<TldPriceResponseHeader></TldPriceResponseHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<TldPriceContent></TldPriceContent>响应内容
<TldContent></TldContent>Tld信息
<Tld></Tld>顶级域名
<Usage></Usage>tld的使用
<Price></Price>此顶级域名价格信息。包含子标签::价格单位:注册费用:续费费用:转让费用。
<Privacy></Privacy>如果此tld支持whois隐私
<GracePeriod></GracePeriod>此 tld 的宽限期信息。包含子标签:<单位>:宽限期信息单位<续订>:续订宽限期<删除>:删除宽限期
<IDN></IDN>如果此tld支持国家化域名
<Restrictions></Restrictions>域名名称
TLD Prices Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=tld_price&currency=USD
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<TldPriceResponse>
  <TldPriceResponseHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <PriceLevel>Regular Pricing</PriceLevel>
    <Currency>USD</Currency>
  </TldPriceResponseHeader>
  <TldPriceContent>
    <TldContent>
      <Tld>.com</Tld>
      <Usage>Usage</Usage>
      <Price>
        <Unit>(Price/1 year)</Unit>
        <Register>99.00</Register>
        <Renew>60.00</Renew>
        <Transfer>92.00</Transfer>
      </Price>
      <Privacy>Yes</Privacy>
      <GracePeriod>
        <Unit>(Grace Period/days)</Unit>
        <Renew>40</Renew>
        <Delete>5</Delete>
      </GracePeriod>
      <IDN>Yes</IDN>
      <Restrictions>--</Restrictions>
    </TldContent>
  </TldPriceContent>
</TldPriceResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=tld_price&currency=USD
Response (JSON format)
{
  "TldPriceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "PriceLevel": "Regular Pricing",
    "Currency": "USD",
    "TldPrice": [
      {
        "Tld": ".com",
        "Usage": "Usage",
        "Price": {
          "Unit": "(Price/1 year)",
          "Register": "99.00",
          "Renew": "60.00",
          "Transfer": "92.00"
        },
        "Privacy": "Yes",
        "GracePeriod": {
          "Unit": "(Grace Period/days)",
          "Renew": "40",
          "Delete": "5"
        },
        "IDN": "Yes",
        "Restrictions": "--"
      }
    ]
  }
}
 

域名列表命令

Support multi-thread

此功能仅在XML和JSON格式中可用:

域名列表请求参数
解释
customer_id (可选)仅经销商可以使用此参数)按客户ID (过滤数据
count_per_page (optional)每页显示多少个实体
page_index (optional)你想查看哪个页面的实体?
sort (optional)请选择以下选项之一作为排序参数的值:
* 如果您没有选择,我们将使用默认排序。
1) CountAsc (默认)
2) CountDesc
3) NameAsc
4) NameDesc
XML结果标签
解释
<ListDomainInfoResponse></ListDomainInfoResponse>响应XML文档的根节点
<ListDomainInfoHeader></ListDomainInfoHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<ListDomainInfoContent></ListDomainInfoContent>响应内容
<DomainInfoList></DomainInfoList>域名信息列表
<DomainInfo></DomainInfo>域名信息
<Domain></Domain>域名
<Name></Name>域名名称
<Expiration></Expiration>以Unix时间计的域名过期日期(毫秒,自1970年1月1日起)
<Registration></Registration>以Unix时间(自UTC时间1, 1970一月午夜起的毫秒数)表示的域名注册日期
<NameServerSettings></NameServerSettings>域名服务器设置
<Type></Type>域名服务器设置类型
<WithAds></WithAds>是否带有广告
<Whois></Whois>Whois信息
<Registrant></Registrant>注册人信息
<ContactId></ContactId>联系方式ID
<Admin></Admin>管理员信息
<Technical></Technical>技术信息
<Billing></Billing>计费信息
<Locked></Locked>是否锁定
<Disabled></Disabled>启用状态
<Hold></Hold>暂停
<Privacy></Privacy>隐私保护状态
<isForSale></isForSale>销售状态
<RenewOption></RenewOption>续费选项
<Note></Note>备注
<Folder></Folder>文件夹信息
<FolderId></FolderId>文件夹ID
<FolderName></FolderName>文件夹名称

列出域名示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=list_domain
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<ListDomainInfoResponse>
  <ListDomainInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ListDomainInfoHeader>
  <ListDomainInfoContent>
    <DomainInfoList>
      <DomainInfo>
        <Domain>
          <Name>domain-exp140.com</Name>
          <Expiration>1361430589062</Expiration>
          <Registration>1234567890123</Registration>
          <NameServerSettings>
            <Type>Dynadot Parking</Type>
            <WithAds>Yes</WithAds>
          </NameServerSettings>
          <Whois>
            <Registrant>
              <ContactId>0</ContactId>
            </Registrant>
            <Admin>
              <ContactId>0</ContactId>
            </Admin>
            <Technical>
              <ContactId>0</ContactId>
            </Technical>
            <Billing>
              <ContactId>0</ContactId>
            </Billing>
          </Whois>
          <Locked>yes</Locked>
          <Disabled>no</Disabled>
          <UdrpLocked>no</UdrpLocked>
          <RegistrantUnverified>no</RegistrantUnverified>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note/>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
        </Domain>
        <Domain>
          <Name>domain-exp141.com</Name>
          <Expiration>1361430589062</Expiration>
          <Registration>1234567890123</Registration>
          <NameServerSettings>
            <Type>Dynadot Parking</Type>
            <WithAds>Yes</WithAds>
          </NameServerSettings>
          <Whois>
            <Registrant>
              <ContactId>1</ContactId>
            </Registrant>
            <Admin>
              <ContactId>2</ContactId>
            </Admin>
            <Technical>
              <ContactId>3</ContactId>
            </Technical>
            <Billing>
              <ContactId>4</ContactId>
            </Billing>
          </Whois>
          <Locked>yes</Locked>
          <Disabled>no</Disabled>
          <UdrpLocked>no</UdrpLocked>
          <RegistrantUnverified>no</RegistrantUnverified>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note/>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
        </Domain>
      </DomainInfo>
    </DomainInfoList>
  </ListDomainInfoContent>
</ListDomainInfoResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=list_domain
Response (JSON format)
{
  "ListDomainInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "MainDomains": [
      {
        "Name": "domain-exp140.com",
        "Expiration": "1361430589062",
        "Registration": "1234567890123",
        "NameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "Yes"
        },
        "Whois": {
          "Registrant": {
            "ContactId": "0"
          },
          "Admin": {
            "ContactId": "0"
          },
          "Technical": {
            "ContactId": "0"
          },
          "Billing": {
            "ContactId": "0"
          }
        },
        "Locked": "yes",
        "Disabled": "no",
        "UdrpLocked": "no",
        "RegistrantUnverified": "no",
        "Hold": "no",
        "Privacy": "none",
        "isForSale": "no",
        "RenewOption": "no renew option",
        "Note": "",
        "Folder": {
          "FolderId": "-1",
          "FolderName": "(no folder)"
        }
      },
      {
        "Name": "domain-exp141.com",
        "Expiration": "1361430589062",
        "Registration": "1234567890123",
        "NameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "Yes"
        },
        "Whois": {
          "Registrant": {
            "ContactId": "1"
          },
          "Admin": {
            "ContactId": "2"
          },
          "Technical": {
            "ContactId": "3"
          },
          "Billing": {
            "ContactId": "4"
          }
        },
        "Locked": "yes",
        "Disabled": "no",
        "UdrpLocked": "no",
        "RegistrantUnverified": "no",
        "Hold": "no",
        "Privacy": "none",
        "isForSale": "no",
        "RenewOption": "no renew option",
        "Note": "",
        "Folder": {
          "FolderId": "-1",
          "FolderName": "(no folder)"
        }
      }
    ]
  }
}
 

域名锁定命令

Support multi-thread

如果调用了锁定域命令,则应包括以下参数:

域名锁定请求参数
解释
domain您想锁定的域名,每个请求只能输入一个1域名
XML结果标签
解释
<LockDomainResponse></LockDomainResponse>响应XML文件的根节点XML文件
<LockDomainHeader></LockDomainHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Lock Domain Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=lock_domain&domain=domain4.com
Response (XML format)
<LockDomainResponse>
   <LockDomainHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </LockDomainHeader>
</LockDomainResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=lock_domain&domain=domain4.com
Response (JSON format)
{
   "LockDomainResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

取消转移命令

Support multi-thread

该命令允许您取消订单中的转移项目。如果调用取消转移命令,则应包含以下参数:

取消传输请求参数
解释
domain您要取消传输的域名,每个请求只能输入一个 1域名。
order_id转移订单ID,您可以从另一个API get_transfer_status中获取。
XML结果标签
解释
<CancelTransferResponse></CancelTransferResponse>响应XML文件的根节点XML文件
<CancelTransferHeader></CancelTransferHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用

取消转让示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=cancel_transfer&domain=domain4.com
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<CancelTransferResponse>
  <CancelTransferHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CancelTransferHeader>
</CancelTransferResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=cancel_transfer&domain=domain4.com
Response (JSON format)
{
  "CancelTransferResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

获取传输状态命令

Support multi-thread

如果调用获取转移状态命令,则应包括以下参数:

获取转移状态请求参数
解释
domain您想要获取转移状态的域名,每次请求只能输入一个1域名
transfer_type您想获取转移状态的转移类型(转入或转出)
XML结果标签
解释
<GetTransferStatusResponse></GetTransferStatusResponse>响应XML文件的根节点XML文件
<GetTransferStatusHeader></GetTransferStatusHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<GetTransferStatusContent></GetTransferStatusContent>响应内容
<TransferList></TransferList>转移列表
<Transfer></Transfer>转移信息
<OrderId></OrderId>订单ID
<TransferStatus></TransferStatus>域名的转移状态。如果获得'没有'或'批准',则可以取消转移。如果获得'等待',表示转移已经开始。如果获得'需要授权码',表示授权码错误,您可以使用另一个API SET_TRANSFER_AUTH重新提交授权码。还有一些其他状态,我们将发送电子邮件或需要由我们的工程师检查。
Get Transfer Status Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetTransferStatusResponse>
  <GetTransferStatusHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetTransferStatusHeader>
  <GetTransferStatusContent>
    <TransferList>
      <Transfer>
        <OrderId>testorderid</OrderId>
        <TransferStatus>teststatus</TransferStatus>
      </Transfer>
      <Transfer>
        <OrderId>testorderid2</OrderId>
        <TransferStatus>teststatus2</TransferStatus>
      </Transfer>
    </TransferList>
  </GetTransferStatusContent>
</GetTransferStatusResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
Response (JSON format)
{
  "GetTransferStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "TransferList": [
      {
        "OrderId": "testorderid",
        "TransferStatus": "teststatus"
      },
      {
        "OrderId": "testorderid2",
        "TransferStatus": "teststatus2"
      }
    ]
  }
}
 

设置转移命令订单的转移授权代码

Support multi-thread

允许您更新处理转移订单的授权代码的命令。如果调用设置传输授权代码命令,则应包括以下参数:

设置转移授权码请求参数
解释
domain您更新转移授权的域名,每个请求只能输入一个 1 域名
auth_code您要重新提交的授权码
order_id转移订单ID,您可以从另一个API get_transfer_status中获取。
XML结果标签
解释
<GetTransferStatusResponse></GetTransferStatusResponse>响应XML文件的根节点XML文件
<GetTransferStatusHeader></GetTransferStatusHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Transfer Auth Code Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Response (XML format)
<SetTransferAuthCodeResponse>
   <SetTransferAuthCodeHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetTransferAuthCodeHeader>
</SetTransferAuthCodeResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Response (JSON format)
{
   "SetTransferAuthCodeResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

授权转移离开命令

Support multi-thread

授权转移请求参数
解释
domain每个请求只能输入一个域名 1 以授权转让
order_id您要转移的域名的Dynadot订单ID
authorize想要批准转移,请设置为“同意”。若想否定转移,请设置为“拒绝”。
XML结果标签
解释
<AuthorizeTransferAwayResponse></AuthorizeTransferAwayResponse>响应XML文件的根节点XML文件
<AuthorizeTransferAwayHeader></AuthorizeTransferAwayHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<Result></Result>授权转移的结果

授权转移示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<AuthorizeTransferAwayResponse>
  <AuthorizeTransferAwayHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <Result>away_approved</Result>
  </AuthorizeTransferAwayHeader>
</AuthorizeTransferAwayResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
Response (JSON format)
{
  "AuthorizeTransferAwayResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Result": "away_approved"
  }
}
 

获取转移授权码命令

Support multi-thread

您必须在请求授权代码前先解锁域名和账户。

获取转移授权代码请求参数
解释
domain您想要为其获取转移授权代码的域名,每一次请求只可以输入1个域名
new_code (optional)生成新的转移授权代码
unlock_domain_for_transfer (Optional. Requires api skip lock agreement to use)如果您要解锁域名进行转移,那么请将其设为等于“1”。如果请求成功得到处理,域名将被解锁。
XML结果标签
解释
<GetTransferAuthCodeResponse></GetTransferAuthCodeResponse>响应XML文件的根节点XML文件
<GetTransferAuthCodeHeader></GetTransferAuthCodeHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<AuthCode></AuthCode>授权代码将用于开启域名转移。

获取转移授权代码示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetTransferAuthCodeResponse>
  <GetTransferAuthCodeHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <AuthCode>testauthcode</AuthCode>
  </GetTransferAuthCodeHeader>
</GetTransferAuthCodeResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
Response (JSON format)
{
  "GetTransferAuthCodeResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AuthCode": "testauthcode"
  }
}
 

获取域名推送请求命令

Support multi-thread

调用获取域名推送请求命令将获取域名推送请求。该命令仅支持XML和JSON格式。

获取域名推送请求参数
解释
N/A无需额外参数
XML结果标签
解释
<GetDomainPushRequestResponse></GetDomainPushRequestResponse>响应的根节点
<GetDomainPushRequestHeader></GetDomainPushRequestHeader>获取域名推送请求头
<ResponseCode></ResponseCode>如果操作成功,则为成功的"0",失败的"-1"
<Status></Status>请求状态
<Error></Error>请求的错误信息仅在状态为“错误”时使用
<GetDomainPushRequestContent></GetDomainPushRequestContent>响应内容
<PushDomain></PushDomain>推送域名
<PushDomainName></PushDomainName>推动域名
Get Domain Push Request Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_domain_push_request
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetDomainPushRequestResponse>
  <GetDomainPushRequestHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetDomainPushRequestHeader>
  <GetDomainPushRequestContent>
    <PushDomain>
      <PushDomainName>haha.com</PushDomainName>
    </PushDomain>
    <PushDomain>
      <PushDomainName>haha1.com</PushDomainName>
    </PushDomain>
  </GetDomainPushRequestContent>
</GetDomainPushRequestResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_domain_push_request
Response (JSON format)
{
  "GetDomainPushRequestResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "pushDomainName": "[haha.com,haha1.com]"
  }
}
 

设置域推送请求命令

Support multi-thread

调用“设置域推送请求命令”将设置域推送请求。此命令仅适用于XML和JSON格式。如果调用此命令,则应包括以下参数:

设置域名推送请求参数
解释
domains待处理订单的域名
action要处理的订单操作,您可以选择'接受'或'拒绝'。
XML结果标签
解释
<SetDomainPushRequestResponse></SetDomainPushRequestResponse>响应的根节点
<SetDomainPushRequestHeader></SetDomainPushRequestHeader>设置域推送请求标头
<ResponseCode></ResponseCode>如果操作成功,则为成功的"0",失败的"-1"
<Status></Status>请求状态
<Error></Error>请求的错误信息仅在状态为“错误”时使用
Set Domain Push Request Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetDomainPushRequestResponse>
  <SetDomainPushRequestHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetDomainPushRequestHeader>
  <SetDomainPushRequestContent/>
</SetDomainPushRequestResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept
Response (JSON format)
{
  "SetDomainPushRequestResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

创建CN审计命令

Support multi-thread

该命令允许为联系人创建CN审计。如果调用创建CN审计命令,应包括以下参数:

创建CN审计请求参数
解释
contact_id您想开始审核的联系记录ID,每个请求只能输入1个联系人ID。
contact_type联系类型,可为“个人”或“企业”
individual_id_type自然人的身份证类型,预期值(值的描述)为:
JGZ (Officer's identity card of the People's Republic of China)
SFZ (ID card of the People's Republic of China)
HZ (Passport)
GAJMTX (Exit-Entry Permit for Travelling to and from Hong Kong and Macao)
TWJMTX (Travel passes for Taiwan Residents to Enter or Leave the Mainland)
WJLSFZ (Foreign Permanent Resident ID Card of the People's Republic of China)
GAJZZ (Residence permit for Hong Kong, Macao)
TWJZZ (Residence permit for Taiwan residents)
QT (Others)
individual_license_id自然人身份证的许可证号码
individual_url自然人许可证 ID 文件的服务器文件 URL。只允许 jpg、gif、png、jpeg 文件
enterprise_id_type (Mandatory when contact type is "Enterprise")企业ID类型,预期值(值的描述)为:
ORG (Organization Code Certificate)
YYZZ (Business License)
TYDM (Certificate for Uniform Social Credit Code)
BDDM (Military Code Designation)
JDDWFW (Military Paid External Service License)
SYDWFR (Public Institution Legal Person Certificate)
WGCZJG (Resident Representative Offices of Foreign Enterprises Registration Form)
SHTTFR (Social Organization Legal Person Registration Certificate)
ZJCS (Religion Activity Site Registration Certificate)
MBFQY (Private Non-Enterprise Entity Registration Certificate)
JJHFR (Fund Legal Person Registration Certificate)
LSZY (Practicing License of Law Firm)
WGZHWH (Registration Certificate of Foreign Cultural Center in China)
WLCZJG (Resident Representative Office of Tourism Departments of Foreign Government Approval Registration Certificate)
SFJD (Judicial Expertise License)
JWJG (Overseas Organization Certificate)
SHFWJG (Social Service Agency Registration Certificate)
MBXXBX (Private School Permit)
YLJGZY (Medical Institution Practicing License)
GZJGZY (Notary Organization Practicing License)
BJWSXX (Beijing School for Children of Foreign Embassy Staff in China Permit)
QTTYDM (Others-Certificate for Uniform Social Credit Code)
QT (Others)
enterprise_license_id (Mandatory when contact type is "Enterprise")企业文件许可证号码
enterprise_url (Mandatory when contact type is "Enterprise")企业许可证文件。服务器上的文件URL。仅允许jpg、gif、png、jpeg
XML结果标签
解释
<CreateCnAuditResponse></CreateCnAuditResponse>响应XML文档的根节点
<CreateCnAuditHeader></CreateCnAuditHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用

创建Cn审计示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=create_cn_audit&contact_id=testcontactid&contact_type=Enterprise&individual_id_type=SFZ&individual_license_id=testlicenseid&individual_url=url1&enterprise_id_type=ORG&enterprise_license_id=testlicenseid2&enterprise_url=url2
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<CreateCnAuditResponse>
  <CreateCnAuditHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateCnAuditHeader>
</CreateCnAuditResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=create_cn_audit&contact_id=testcontactid&contact_type=Enterprise&individual_id_type=SFZ&individual_license_id=testlicenseid&individual_url=url1&enterprise_id_type=ORG&enterprise_license_id=testlicenseid2&enterprise_url=url2
Response (JSON format)
{
  "CreateCnAuditResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

获取Cn审计状态命令

Support multi-thread

如果调用 get cn 审核状态命令,则应包含以下参数:

获取Cn审计状态请求参数
解释
contact_id您想获取审计状态的联系人记录ID,每个请求仅限输入1个contactId
gtld如果查询cnnic-gtld的审计结果,请将此参数设置为1
XML结果标签
解释
<GetCnAuditStatusResponse></GetCnAuditStatusResponse>响应XML文件的根节点XML文件
<GetCnAuditStatusHeader></GetCnAuditStatusHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<CnAuditStatus></CnAuditStatus>CNNIC审核记录的审核状态。您可能会得到'处理中'、'等待CNNIC'或'失败'。如果失败,我们将发送电子邮件给您。
<FailedReason></FailedReason>如果审计不合格,将显示失败原因

获取Cn审计状态示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_cn_audit_status&contact_id=testcontactid
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetCnAuditStatusResponse>
  <GetCnAuditStatusHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <CnAuditStatus>pass</CnAuditStatus>
  </GetCnAuditStatusHeader>
</GetCnAuditStatusResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_cn_audit_status&contact_id=testcontactid
Response (JSON format)
{
  "GetCnAuditStatusResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "CnAuditStatus": "pass"
  }
}
 

创建联系方式命令

Support multi-thread

如果发送创建联系方式命令,则须包含下列参数:

创建联络人请求参数
解释
organization (可选)机构信息
name名称
email邮箱
phonenum电话号码
phonecc国家区号
faxnum (可选)传真号码
faxcc (可选)传真国家区号
address1地址1
address2 (可选)第2行地址
city城市
state (可选)
zip邮政区代码
country国家
XML结果标签
解释
<CreateContactResponse></CreateContactResponse>响应XML文档的根节点
<CreateContactHeader></CreateContactHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<CreateContactContent></CreateContactContent>新联系人ID,仅在状态为"success"时使用。
Create Contact Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US
Response (XML format)
<CreateContactResponse>
  <CreateContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateContactHeader>
  <CreateContactContent>
    <ContactId>1234</ContactId>
  </CreateContactContent>
</CreateContactResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US
Response (JSON format)
{
   "CreateContactResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "CreateContactContent":{
         "ContactId":"0"
      }
   }
}
 

遍及联系方式命令

Support multi-thread

如果发送遍及联系方式命令,则须包含下列参数:

编辑联络人请求参数
解释
contact_id您要编辑的联络人ID
organization (可选)机构信息
name名称
email邮箱
phonenum电话号码
phonecc国家区号
faxnum (可选)传真号码
faxcc (可选)传真国家区号
address1地址第1行
address2 (可选)第2行地址
city城市
state
zip邮政区代码
country国家
XML结果标签
解释
<EditContactResponse></EditContactResponse>响应XML文档的根节点
<EditContactHeader></EditContactHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<EditContactContent></EditContactContent>响应内容
<ContactId></ContactId>联络人ID

编辑联系人示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<EditContactResponse>
  <EditContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </EditContactHeader>
  <EditContactContent>
    <ContactId>0</ContactId>
  </EditContactContent>
</EditContactResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
Response (JSON format)
{
  "EditContactResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "EditContactContent": {
      "ContactId": "0"
    }
  }
}
Request 领域行业相关的专业要求。https://api.dynadot.com/api3.html?key=[API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
Response 领域行业相关的专业要求。
ok,

success,
,
 

删除联系方式命令

Support multi-thread

如果发送删除联系方式命令,则须包含下列参数:

删除联系方式请求参数
解释
contact_id您要删除的联络人ID,务必使用逗号隔开
XML结果标签
解释
<DeleteContactResponse></DeleteContactResponse>响应XML文档的根节点
<DeleteContactHeader></DeleteContactHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用

删除联系方式示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_contact&contact_id=0
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteContactResponse>
  <DeleteContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteContactHeader>
</DeleteContactResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_contact&contact_id=0
Response (JSON format)
{
  "DeleteContactResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

联系方式列表命令

Support multi-thread

此命令仅适用于XML和JSON格式:

联系方式列表请求参数
解释
N/A无需额外参数
XML结果标签
解释
<ContactListResponse></ContactListResponse>响应XML文档的根节点
<ContactListHeader></ContactListHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<ContactListContent></ContactListContent>响应内容
<ContactList></ContactList>联系方式列表
<Contact></Contact>联系方式信息
<ContactId></ContactId>联络人ID
<Organization></Organization>联系机构
<Name></Name>名称
<Email></Email>邮箱
<PhoneCc></PhoneCc>国家区号
<PhoneNum></PhoneNum>电话号码
<FaxCc></FaxCc>传真国家区号
<FaxNum></FaxNum>传真号码
<Address1></Address1>地址第1行
<Address2></Address2>第2行地址
<City></City>城市
<State></State>
<ZipCode></ZipCode>邮政区代码
<Country></Country>国家
<GtldVerified></GtldVerified>gTLD验证状态
Contact List Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=contact_list
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<ContactListResponse>
  <ContactListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ContactListHeader>
  <ContactListContent>
    <ContactList>
      <Contact>
        <ContactId>0</ContactId>
        <Organization/>
        <Name>Jack tester</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>test street</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
      <Contact>
        <ContactId>1</ContactId>
        <Organization/>
        <Name>John tester</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>123.456.7890</PhoneNum>
        <FaxCc>1</FaxCc>
        <FaxNum>123.456.7890</FaxNum>
        <Address1>high Way first</Address1>
        <Address2/>
        <City>San Francisco</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>yes</GtldVerified>
      </Contact>
    </ContactList>
  </ContactListContent>
</ContactListResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=contact_list
Response (JSON format)
{
  "ContactListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ContactList": [
      {
        "ContactId": "0",
        "Organization": "",
        "Name": "Jack tester",
        "Email": "[email protected]",
        "PhoneCc": "1",
        "PhoneNum": "555.555.5233",
        "FaxCc": "",
        "FaxNum": "",
        "Address1": "test street",
        "Address2": "",
        "City": "Los Angeles",
        "State": "CA",
        "ZipCode": "90068",
        "Country": "US",
        "GtldVerified": "no"
      },
      {
        "ContactId": "1",
        "Organization": "",
        "Name": "John tester",
        "Email": "[email protected]",
        "PhoneCc": "1",
        "PhoneNum": "123.456.7890",
        "FaxCc": "1",
        "FaxNum": "123.456.7890",
        "Address1": "high Way first",
        "Address2": "",
        "City": "San Francisco",
        "State": "CA",
        "ZipCode": "90068",
        "Country": "US",
        "GtldVerified": "yes"
      }
    ]
  }
}
 

获取联络人命令

Support multi-thread

此命令仅适用于XML和JSON格式:

获取联络人请求参数
解释
contact_id联络人ID
XML结果标签
解释
<GetContactResponse></GetContactResponse>响应XML文档的根节点
<GetContactHeader></GetContactHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<GetContactContent></GetContactContent>响应内容
<Contact></Contact>联系方式信息
<ContactId></ContactId>联络人ID
<Organization></Organization>联系机构
<Name></Name>名称
<Email></Email>邮箱
<PhoneCc></PhoneCc>国家区号
<PhoneNum></PhoneNum>电话号码
<FaxCc></FaxCc>传真国家区号
<FaxNum></FaxNum>传真号码
<Address1></Address1>地址第1行
<Address2></Address2>第2行地址
<City></City>城市
<State></State>
<ZipCode></ZipCode>邮政区代码
<Country></Country>国家
<GtldVerified></GtldVerified>gTLD验证状态
Get Contact Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_contact&contact_id=10000
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetContactResponse>
  <GetContactHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetContactHeader>
  <GetContactContent>
    <GetContact>
      <Contact>
        <ContactId>12345</ContactId>
        <Organization>org</Organization>
        <Name>name</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>address1</Address1>
        <Address2>address2</Address2>
        <City>city</City>
        <State>state</State>
        <ZipCode>zipcode</ZipCode>
        <Country>country</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
    </GetContact>
  </GetContactContent>
</GetContactResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_contact&contact_id=10000
Response (JSON format)
{
  "GetContactResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetContact": {
      "ContactId": "12345",
      "Organization": "org",
      "Name": "name",
      "Email": "[email protected]",
      "PhoneCc": "1",
      "PhoneNum": "555.555.5233",
      "FaxCc": "",
      "FaxNum": "",
      "Address1": "address1",
      "Address2": "address2",
      "City": "city",
      "State": "state",
      "ZipCode": "zipcode",
      "Country": "country",
      "GtldVerified": "no"
    }
  }
}
 

设置联系欧盟设置命令

Support multi-thread

如果调用设置联系人欧盟设置命令,则应包括以下参数:

设置联系人EU设置请求参数
解释
contact_id您要编辑的联络人ID
country_of_citizenship必须是欧盟成员国。成员国的国家代码包括:AT,BE,BG,HR,CY,CZ,DK,EE,FI,FR,DE,GR,HU,IS,IE,IT,LV,LI,LT,LU,MT,NL,NO,PL,PT,RO,SK,SI,ES,SE。
XML结果标签
解释
<SetContactEUSettingResponse></SetContactEUSettingResponse>响应XML文档的根节点
<SetContactEUSettingHeader></SetContactEUSettingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<SetContactEUSettingContent></SetContactEUSettingContent>响应内容
<ContactId></ContactId>联络人ID
Set Contact EU Setting Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactEUSettingResponse>
  <SetContactEUSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactEUSettingHeader>
  <SetContactEUSettingContent>
    <ContactId>0</ContactId>
  </SetContactEUSettingContent>
</SetContactEUSettingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Response (JSON format)
{
  "SetContactEUSettingResponse": {
    "ResponseCode: ": "0",
    "Status": "Success",
    "SetContactEUSettingContent": {
      "ContactId: ": "0"
    }
  }
}
 

设置联系人LV设置命令

Support multi-thread

如果调用设置联系人lv命令,应包括以下参数:

设置联系LV设置请求参数
解释
contact_id您要编辑的联络人ID
registration_number- 对于个人,请输入拉脱维亚身份证号码。
- 对于公司和其他法人实体,请输入由拉脱维亚企业注册局颁发的注册号码。
vat_number (可选)欧洲联盟国家注册的外国法人增值税号(包括拉脱维亚公司)
XML结果标签
解释
<SetContactLvSettingResponse></SetContactLvSettingResponse>响应XML文档的根节点
<SetContactLvSettingHeader></SetContactLvSettingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<SetContactLvSettingContent></SetContactLvSettingContent>响应内容
<ContactId></ContactId>联络人ID

联系等级设置示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactLvSettingResponse>
  <SetContactLvSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactLvSettingHeader>
  <SetContactLvSettingContent>
    <ContactId>0</ContactId>
  </SetContactLvSettingContent>
</SetContactLvSettingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
Response (JSON format)
{
  "SetContactLvSettingResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetContactLvSettingContent": {
      "ContactId: ": "0"
    }
  }
}
Set Contact LV Setting Example
Request 领域行业相关的专业要求。https://api.dynadot.com/api3.html?key=[API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
Response 领域行业相关的专业要求。
ok,success,0
 

获取域名服务器命令

Support multi-thread

如果调用获取域名服务器命令,则应包含以下参数:

获取域名服务器请求参数
解释
domain您想获得的该域名的域名服务器信息,每次请求仅能抓取1条该域名的域名服务器信息
XML结果标签
解释
<GetNsResponse></GetNsResponse>响应XML文档的根节点
<GetNsHeader></GetNsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<NsContent></NsContent>响应内容
<Host></Host>服务器主机名
<NsName></NsName>服务器名称

获取Ns示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_ns&domain=mydomain.com
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetNsResponse>
  <GetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetNsHeader>
  <NsContent>
    <Host>ns1.mydomain.com</Host>
    <Host>ns2.mydomain.com</Host>
  </NsContent>
</GetNsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_ns&domain=mydomain.com
Response (JSON format)
{
  "GetNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "nsContent": {
      "Host0": "ns1.mydomain.com",
      "Host1": "ns2.mydomain.com"
    }
  }
}
 

添加域名服务器命令

Support multi-thread

若呼叫添加域名服务器命令,则需包含以下参数:

添加域名服务器请求参数
解释
host您想添加的域名服务器主机名称
XML结果标签
解释
<AddNsResponse></AddNsResponse>响应XML文档的根节点
<AddNsHeader></AddNsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<AddNsContent></AddNsContent>响应内容
<Server></Server>您已经设置的服务器
<Host></Host>新服务器的托管名称
<ServerId></ServerId>新服务器ID

行业相关的专业域名industry domains.

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=add_ns&host=ns1.mydomain.com
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<AddNsResponse>
  <AddNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddNsHeader>
  <AddNsContent>
    <Server>
      <Host>ns1.mydomain.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </AddNsContent>
</AddNsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=add_ns&host=ns1.mydomain.com
Response (JSON format)
{
  "AddNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AddNsContent": {
      "Server": {
        "Host": "ns1.mydomain.com",
        "ServerId": 0
      }
    }
  }
}
 

注册域名服务器命令

Support multi-thread

如果呼叫注册域名服务器命令,则应包含下列参数:

注册域名服务器请求参数
解释
host您自己域名服务器的主机名称
ip您自己的域名服务器IP地址
XML结果标签
解释
<RegisterNsResponse></RegisterNsResponse>响应XML文档的根节点
<RegisterNsHeader></RegisterNsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<RegisterNsContent></RegisterNsContent>响应内容
<Server></Server>服务器标签
<Host></Host>托管名称
<ServerId></ServerId>服务器ID
Register Name Server Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
Response (XML format)
<RegisterNsResponse>
  <RegisterNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterNsHeader>
  <RegisterNsContent>
    <Server>
      <Host>domain1.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </RegisterNsContent>
</RegisterNsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
Response (JSON format)
{
   "RegisterNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "RegisterNsContent":{
         "Server":{
            "Host":"ndomain1.com",
            "ServerId":"0"
         }
      }
   }
}
 

设置域名服务器IP命令

Support multi-thread

若呼叫设置域名服务器IP命令,则应包含以下参数:

设置域名服务器IP请求参数
解释
server_id您要设置的域名服务器ID
ip0 - ip9您要为域名服务器设置的IP地址,每个请求可以设置9个IP,需用逗号隔开
XML结果标签
解释
<SetNsIpResponse></SetNsIpResponse>响应XML文档的根节点
<SetNsIpHeader></SetNsIpHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Name Server IP Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Response (XML format)
<SetNsIpResponse>
  <SetNsIpHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsIpHeader>
</SetNsIpResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Response (JSON format)
{
   "SetNsIpResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

删除域名服务器命令

Support multi-thread

如果呼叫删除域名服务器命令,则应包含下列参数:

删除域名服务器请求参数
解释
server_id您想删除的域名服务器ID,请务必使用逗号将其隔开
XML结果标签
解释
<DeleteNsResponse></DeleteNsResponse>响应XML文档的根节点
<DeleteNsHeader></DeleteNsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用

领域行业相关的专业要求。

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_ns&server_id=0
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_ns&server_id=0
Response (JSON format)
{
  "DeleteNsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

通过域命令删除域名服务器

Support multi-thread

如果通过域命令调用删除域名服务器,则应包括以下参数:

通过域名请求参数删除域名服务器
解释
server_domain域名服务器名称。例如:ns1.testnameserver.com
XML结果标签
解释
<DeleteNsResponse></DeleteNsResponse>响应XML文档的根节点
<DeleteNsHeader></DeleteNsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Delete Name Server By Domain Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Response (XML format)
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Response (JSON format)
{
   "DeleteNsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

服务器列表命令

Support multi-thread

此命令仅适用于XML和JSON格式:

服务器列表请求参数
解释
N/A无需额外参数
XML结果标签
解释
<ServerListResponse></ServerListResponse>响应XML文档的根节点
<ServerListHeader></ServerListHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<ServerListContent></ServerListContent>响应内容
<NameServerList></NameServerList>域名服务器列表
<List></List>
<Server></Server>
<ServerId></ServerId>服务器ID
<ServerName></ServerName>服务器名称
<ServerIp></ServerIp>服务器IP
Server List Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=server_list
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<ServerListResponse>
  <ServerListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ServerListHeader>
  <ServerListContent>
    <NameServerList>
      <List>
        <Server>
          <ServerId>0</ServerId>
          <ServerName>ns1.com</ServerName>
        </Server>
        <Server>
          <ServerId>1</ServerId>
          <ServerName>domain1.com</ServerName>
          <ServerIp>192.168.1.1</ServerIp>
          <ServerIp>1.1.1.1</ServerIp>
        </Server>
      </List>
    </NameServerList>
  </ServerListContent>
</ServerListResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=server_list
Response (JSON format)
{
  "ServerListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ServerList": [
      {
        "ServerId": "0",
        "ServerName": "ns1.com"
      },
      {
        "ServerId": "1",
        "ServerName": "domain1.com",
        "ServerIps": [
          {
            "Ip": "192.168.1.1"
          },
          {
            "Ip": "1.1.1.1"
          }
        ]
      }
    ]
  }
}
 

获取域名服务器设置命令

Support multi-thread

如果调用获取域名服务器设置命令,则应包括以下参数:

获取域名服务器设置请求参数
解释
domain你想获取域名服务器设置的域只能每个请求拉取1域名服务器设置。
XML结果标签
解释
<GetDnsResponse></GetDnsResponse>响应XML文档的根节点
<GetDnsHeader></GetDnsHeader>响应标头
<ResponseCode></ResponseCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<GetDnsContent></GetDnsContent>响应内容
<NameServerSettings></NameServerSettings>域名的域名服务器设置
<Type></Type>域名的域名服务器类型
Get Domain Nameserver Settings Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_dns&domain=mydomain.com
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetDnsResponse>
  <GetDnsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetDnsHeader>
  <GetDnsContent>
    <NameServerSettings>
      <Type>Dynadot Parking</Type>
      <WithAds>Yes</WithAds>
    </NameServerSettings>
  </GetDnsContent>
</GetDnsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_dns&domain=mydomain.com
Response (JSON format)
{
  "GetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetDns": {
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      }
    }
  }
}
 

账户信息命令

Support multi-thread

此命令仅适用于XML和JSON格式:

账户信息请求参数
解释
N/A无需额外参数
XML结果标签
解释
<AccountInfoResponse></AccountInfoResponse>响应XML文档的根节点
<AccountInfoHeader></AccountInfoHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<AccountInfoContent></AccountInfoContent>响应内容
<AccountInfo></AccountInfo>账户信息
<Username></Username>用户名
<ForumName></ForumName>论坛名称
<Contact></Contact>联系方式信息
<Organization></Organization>整理与归纳
<Organization></Organization>响应标头
<Name></Name>您的名称
<Email></Email>邮箱
<PhoneCc></PhoneCc>国家区号
<PhoneNum></PhoneNum>电话号码
<Address1></Address1>地址第1行
<Address2></Address2>第2行地址
<City></City>城市
<State></State>
<ZipCode></ZipCode>邮政区代码
<Country></Country>国家
<CustomerSince></CustomerSince>客户身份始于
<AccountLock></AccountLock>账户锁定
<TotalSpending></TotalSpending>花费总计
<PriceLevel></PriceLevel>价格级别
<AccountBalance></AccountBalance>账户余额
<CustomTimeZone></CustomTimeZone>自定义时区
<DefaultSettings></DefaultSettings>默认设置
<DefaultWhois></DefaultWhois>默认Whois
<DefaultRegistrant></DefaultRegistrant>默认注册人
<ContactId></ContactId>联络人ID
<DefaultAdmin></DefaultAdmin>默认管理员
<DefaultTechnical></DefaultTechnical>默认技术类型
<DefaultBilling></DefaultBilling>默认账单
<Type></Type>域名服务器类型
<WithAds></WithAds>是否带有广告
Account Information Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=account_info
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<AccountInfoResponse>
  <AccountInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </AccountInfoHeader>
  <AccountInfoContent>
    <AccountInfo>
      <Username>testname</Username>
      <ForumName>test forum name</ForumName>
      <Contact>
        <Organization/>
        <Name>testname test</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>1 test road</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90000</ZipCode>
        <Country>US</Country>
      </Contact>
      <CustomerSince>1364888735253</CustomerSince>
      <AccountLock>on</AccountLock>
      <TotalSpending>$0.00</TotalSpending>
      <PriceLevel>Regular Pricing</PriceLevel>
      <AccountBalance>$70.02</AccountBalance>
      <CustomTimeZone>PST</CustomTimeZone>
      <DefaultSettings>
        <DefaultWhois>
          <DefaultRegistrant>
            <ContactId>0</ContactId>
          </DefaultRegistrant>
          <DefaultAdmin>
            <ContactId>0</ContactId>
          </DefaultAdmin>
          <DefaultTechnical>
            <ContactId>0</ContactId>
          </DefaultTechnical>
          <DefaultBilling>
            <ContactId>0</ContactId>
          </DefaultBilling>
        </DefaultWhois>
        <DefaultNameServerSettings>
          <Type>Dynadot Parking</Type>
          <WithAds>yes</WithAds>
        </DefaultNameServerSettings>
      </DefaultSettings>
    </AccountInfo>
  </AccountInfoContent>
</AccountInfoResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=account_info
Response (JSON format)
{
  "AccountInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AccountInfo": {
      "Username": "testname",
      "ForumName": "test forum name",
      "Contact": {
        "Organization": "",
        "Name": "testname test",
        "Email": "[email protected]",
        "PhoneCc": "1",
        "PhoneNum": "555.555.5233",
        "FaxCc": "",
        "FaxNum": "",
        "Address1": "1 test road",
        "Address2": "",
        "City": "Los Angeles",
        "State": "CA",
        "ZipCode": "90000",
        "Country": "US"
      },
      "CustomerSince": "1364888735253",
      "AccountLock": "on",
      "TotalSpending": "$0.00",
      "PriceLevel": "Regular Pricing",
      "AccountBalance": "$70.02",
      "CustomTimeZone": "PST",
      "DefaultSettings": {
        "DefaultWhois": {
          "DefaultRegistrant": {
            "ContactId": "0"
          },
          "DefaultAdmin": {
            "ContactId": "0"
          },
          "DefaultTechnical": {
            "ContactId": "0"
          },
          "DefaultBilling": {
            "ContactId": "0"
          }
        },
        "DefaultNameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "yes"
        }
      }
    }
  }
}
 

获取账户余额命令

Support multi-thread

此命令仅适用于XML和JSON格式:

获取账户余额请求参数
解释
N/A无需额外参数
XML结果标签
解释
<GetAccountBalanceResponse></GetAccountBalanceResponse>响应XML文件的根节点XML文件
<GetAccountBalanceHeader></GetAccountBalanceHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<GetAccountBalanceContent></GetAccountBalanceContent>响应内容
<Balance></Balance>帐户余额
Get Account Balance Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_account_balance
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetAccountBalanceResponse>
  <GetAccountBalanceHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAccountBalanceHeader>
  <GetAccountBalanceContent>
    <BalanceList>
      <Balance>
        <Currency>USD</Currency>
        <Amount>300.00</Amount>
      </Balance>
    </BalanceList>
  </GetAccountBalanceContent>
</GetAccountBalanceResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_account_balance
Response (JSON format)
{
  "GetAccountBalanceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BalanceList": [
      {
        "Currency": "USD",
        "Amount": "300.00"
      }
    ]
  }
}
 

设置默认Whois

Support multi-thread

如果呼叫设置默认Whois命令,则应包含以下参数:

设置默认Whois请求参数
解释
registrant_contact域名的注册人信息
admin_contact域名管理员信息
technical_contact域名的技术信息
billing_contact域名的计费信息
XML结果标签
解释
<SetDefaultWhoisResponse></SetDefaultWhoisResponse>响应XML文档的根节点
<SetDefaultWhoisHeader></SetDefaultWhoisHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Default Whois Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Response (XML format)
<SetDefaultWhoisResponse>
   <SetDefaultWhoisHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultWhoisHeader>
</SetDefaultWhoisResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Response (JSON format)
{
   "SetDefaultWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认域名服务器命令

Support multi-thread

如果呼叫设置默认域名服务器命令,则应包含下列参数:

设置默认域名服务器请求参数
解释
ns0 - ns12您要设置的域名服务器
XML结果标签
解释
<SetDefaultNsResponse></SetDefaultNsResponse>设置默认域名服务器响应标签,它是XML文档响应的根节点
<SetDefaultNsHeader></SetDefaultNsHeader>设置默认域名服务器标题标签
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<SetDefaultNsContent></SetDefaultNsContent>设置默认域名服务器内容标签,仅当状态为"success"时使用
<Servers></Servers>已设置的服务器信息
<Server></Server>每个服务器
<ServerName></ServerName>服务器名称
<ServerId></ServerId>服务器id

设置默认 Ns 示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetDefaultNsResponse>
  <SetDefaultNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultNsHeader>
  <SetDefaultNsContent>
    <Servers>
      <Server>
        <ServerName>ns1.hosts.com</ServerName>
        <ServerId>0</ServerId>
      </Server>
      <Server>
        <ServerName>ns2.hosts.com</ServerName>
        <ServerId>1</ServerId>
      </Server>
    </Servers>
  </SetDefaultNsContent>
</SetDefaultNsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Response (JSON format)
{
  "SetDefaultNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetDefaultNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}
 

设置默认停放命令

Support multi-thread

如果发送设置默认停放命令,则须包含下列参数:

设置默认停放请求参数
解释
with_ads (可选)如果您不想要第三方广告,则可将此参数设置为"no",,默认值为"yes"
XML结果标签
解释
<SetDefaultParkingResponse></SetDefaultParkingResponse>响应XML文档的根节点
<SetDefaultParkingHeader></SetDefaultParkingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Default Parking Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_parking&folder_id=0&with_ads=no
Response (XML format)
<SetDefaultParkingResponse>
   <SetDefaultParkingHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultParkingHeader>
</SetDefaultParkingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_parking&folder_id=0&with_ads=no
Response (JSON format)
{
   "SetDefaultParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认转发命令

Support multi-thread

如果发送设置默认转发命令,则须包含下列参数:

设置默认转发请求参数
解释
forward_url您希望域名转发至的URL地址。请注意,参数必须为已编码,以便API调用可得到正确解析。
is_temp (可选)您要跳转域名的跳转状态,默认值为"temporary",,若您要永久跳转,则可将此参数设为"no"
XML结果标签
解释
<SetDefaultForwardingResponse></SetDefaultForwardingResponse>响应XML文档的根节点
<SetDefaultForwardingHeader></SetDefaultForwardingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Default Forwarding Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
Response (XML format)
<SetDefaultForwardingResponse>
  <SetDefaultForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultForwardingHeader>
</SetDefaultForwardingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
Response (JSON format)
{
   "SetDefaultForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认隐身命令

Support multi-thread

如果要发送默认隐身命令,则须包含下列参数:

设置默认隐身请求参数
解释
stealth_url您希望域名转发至的URL地址。请注意,参数必须为已编码,以便API调用可得到正确解析。
stealth_title (可选)页面标题
XML结果标签
解释
<SetDefaultStealthResponse></SetDefaultStealthResponse>响应XML文档的根节点
<SetDefaultStealthHeader></SetDefaultStealthHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Default Stealth Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Response (XML format)
<SetDefaultStealthResponse>
  <SetDefaultStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultStealthHeader>
</SetDefaultStealthResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Response (JSON format)
{
   "SetDefaultStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认托管命令

Support multi-thread

如果发送设置默认托管命令,则须包含下列参数:

设置默认托管请求参数
解释
hosting_type您想要的默认托管类型,可以选择"advanced"和"basic"
XML结果标签
解释
<SetDefaultHostingResponse></SetDefaultHostingResponse>响应XML文档的根节点
<SetDefaultHostingHeader></SetDefaultHostingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Default Hosting Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_hosting&hosting_type=advanced
Response (XML format)
<SetDefaultHostingResponse>
  <SetDefaultHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultHostingHeader>
</SetDefaultHostingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_hosting&hosting_type=advanced
Response (JSON format)
{
   "SetDefaultHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认域名系统命令

Support multi-thread

如果发送设置默认域名系统命令,则须包含下列参数:

这个命令已经过时,请使用设置默认DNS2命令。

设置默认域名系统请求参数
解释
main_record_type主要记录类型
main_record为您的域名制定一个域名系统记录
main_txt (可选)为您的域名指定TXT记录;若your main_record_type为aaaa,且指定了一个main_record2,则您可设置多达3个main_txts,否则,您可设置多达4个main_txts
main_record2主记录2,仅当"main_record_type"为"aaaa"时使用,其值必须为IPV4格式
subdomain0 - subdomain99 (可选)子域名记录
sub_record_type0 - sub_record_type99 (可选)子域名记录类型
sub_record0 - sub_record99 (可选)IP地址或目标主机
mx_host0 - mx_host2 (可选)指定您域名的邮箱主机,distance0为最高优先级
mx_distance0 - mx_distance2 (可选)Distance0为最高优先级
ttl (可选)生存时间
XML结果标签
解释
<SetDefaultDnsResponse></SetDefaultDnsResponse>响应XML文档的根节点
<SetDefaultDnsHeader></SetDefaultDnsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Default DNS Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Response (XML format)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Response (JSON format)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认DNS2命令

Support multi-thread

如果发送设置默认域名系统命令,则须包含下列参数:

设置默认DNS2请求参数
解释
main_record_type0 - main_record_type19主要记录类型
main_record0 - main_record19为您的域名指定DNS记录
main_recordx0 - main_recordx19Mx距离、转发类型、隐形转发标题或电子邮件别名当main_record_type为"a"、"aaaa"、"cname"、"forward"、"txt"、"mx"、"stealth"、"email"时必须提供
subdomain0 - subdomain99 (可选)子域名记录
sub_record_type0 - sub_record_type99 (可选)子域名记录类型
sub_record0 - sub_record99 (可选)子域名IP地址或目标主机
sub_recordx0 - subdo_recordx99Mx距离、转发类型、隐形转发标题或电子邮件别名当sub_record_type为"a"、"aaaa"、"cname"、"forward"、"txt"、"srv"、"mx"、"stealth"、"email"时必须提供
ttl (可选)生存时间
XML结果标签
解释
<SetDefaultDnsResponse></SetDefaultDnsResponse>响应XML文档的根节点
<SetDefaultDnsHeader></SetDefaultDnsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Default DNS2 Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Response (XML format)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Response (JSON format)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认电子邮件转发命令

Support multi-thread

如果发送设置默认电子邮件转发命令,则须包含下列参数:

设置默认电子邮件转发请求参数
解释
forward_type转发类型,可以是"donot"::不要转发邮件;"mx":将邮件转发给另一个邮箱主机(MX记录);"forward"::将邮件转发给另一个邮箱主机
username0 - username9用户名,仅"forward_type"为"forward"时使用
exist_email0 - exist_email9现有电子邮箱地址,仅当"forward_type"为"forward"时使用
mx_host0 - mx_host2邮箱主机,仅"forward_type"为"mx"时使用
mx_distance0 - mx_distance2Distance0为最高优先级,仅当"forward_type"为"mx"时使用
XML结果标签
解释
<SetDefaultEmailForwardingResponse></SetDefaultEmailForwardingResponse>响应XML文档的根节点
<SetDefaultEmailForwardingHeader></SetDefaultEmailForwardingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Default Email Forward Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
Response (XML format)
<SetDefaultEmailForwardingResponse>
  <SetDefaultEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultEmailForwardingHeader>
</SetDefaultEmailForwardingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
Response (JSON format)
{
   "SetDefaultEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置清除默认设置命令

Support multi-thread

如果呼叫设置清除默认设置命令,则需包含以下参数:

设置清除默认设置请求参数
解释
service您要清除的服务,它可以是“转发”、“隐形”、“电子邮件转发”、“dns”和“名字服务器”
XML结果标签
解释
<SetClearDefaultSettingResponse></SetClearDefaultSettingResponse>响应XML文档的根节点
<SetClearDefaultSettingHeader></SetClearDefaultSettingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Clear Default Setting Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_default_setting&service=nameservers
Response (XML format)
<SetClearDefaultSettingResponse>
  <SetClearDefaultSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDefaultSettingHeader>
</SetClearDefaultSettingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_default_setting&service=nameservers
Response (JSON format)
{
   "SetClearDefaultSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认续费选项命令

Support multi-thread

如果发送设置默认续费选项命令,则须包含下列参数:

设置默认续费选项请求参数
解释
renew_option可以是"donot", "auto", "reset"
XML结果标签
解释
<SetDefaultRenewOptionResponse></SetDefaultRenewOptionResponse>响应XML文档的根节点
<SetDefaultRenewOptionHeader></SetDefaultRenewOptionHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用

设置默认续费选项示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_renew_option&renew_option=auto
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetDefaultRenewOptionResponse>
  <SetDefaultRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultRenewOptionHeader>
</SetDefaultRenewOptionResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_renew_option&renew_option=auto
Response (JSON format)
{
  "SetDefaultRenewOptionResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

创建文件夹命令

Support multi-thread

如果发送创建文件夹命令,则须包含下列参数:

创建文件夹请求参数
解释
folder_name您想创建的文件夹名称
XML结果标签
解释
<FolderCreateResponse></FolderCreateResponse>响应XML文档的根节点
<FolderCreateHeader></FolderCreateHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<FolderCreateContent></FolderCreateContent>响应内容
<FolderName></FolderName>文件夹名称
<FolderId></FolderId>新文件夹ID
Create Folder Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=create_folder&folder_name=new
Response (XML format)
<FolderCreateResponse>
  <FolderCreateHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </FolderCreateHeader>
  <FolderCreateContent>
    <FolderName>new</FolderName>
    <FolderId>1</FolderId>
  </FolderCreateContent>
</FolderCreateResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=create_folder&folder_name=new
Response (JSON format)
{
   "FolderCreateResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "FolderCreateContent":{
         "FolderName":"new",
         "FolderId":"1"
      }
   }
}
 

删除文件夹命令

Support multi-thread

如果设置Whois命令,则应包含以下参数:

删除文件夹请求参数
解释
folder_id您要删除的文件夹ID,确保用逗号分隔
XML结果标签
解释
<DeleteFolderResponse></DeleteFolderResponse>响应XML文档的根节点
<DeleteFolderHeader></DeleteFolderHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用

删除文件夹例子

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_folder&folder_id=0,1
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteFolderResponse>
  <DeleteFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteFolderHeader>
</DeleteFolderResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_folder&folder_id=0,1
Response (JSON format)
{
  "DeleteFolderResponse": {
    "SuccessCode": 0,
    "Status": "success"
  }
}
 

设置文件夹Whois命令

Support multi-thread

如果呼叫设置文件夹Whois命令,则应包含下列参数:

设置文件夹Whois请求参数
解释
folder_id您要设置的文件夹ID
registrant_contact域名的注册人信息
admin_contact域名管理员信息
technical_contact域名的技术信息
billing_contact域名的计费信息
enable (可选)如果您要将此Whois设置应用于今后移动至此文件夹的域名,则可将此参数设为"yes"
sync (可选)如果您要将此Whois设置同步于此文件夹下的所有域名,则应将此参数设为"yes"
XML结果标签
解释
<SetFolderWhoisResponse></SetFolderWhoisResponse>响应XML文档的根节点
<SetFolderWhoisHeader></SetFolderWhoisHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Folder Whois Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Response (XML format)
<SetFolderWhoisResponse>
  <SetFolderWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderWhoisHeader>
</SetFolderWhoisResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Response (JSON format)
{
   "SetFolderWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹域名服务器命令

Support multi-thread

如果呼叫设置文件夹域名服务器命令,则应包含下列参数:

设置域名服务器文件夹请求参数
解释
fold_id您要设置的文件夹ID,每个请求可设置1个文件夹
ns0 - ns12您要设置并启用域名的域名服务器,您可指定多达13个域名服务器,但它们必须已经在您的账户中
enable (可选)如果您要将此域名服务器设置应用于今后移动至该文件夹的域名,则可将此参数设为"yes"
sync (可选)若要同步该文件夹下所有域名的域名服务器设置,则可将此参数设为"yes"
XML结果标签
解释
<SetFolderNsResponse></SetFolderNsResponse>设置域名服务器响应标签,它是响应XML文档的根节点
<SetFolderNsHeader></SetFolderNsHeader>设置文件夹域名服务器响应标题标签
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<SetFolderNsContent></SetFolderNsContent>设置文件夹域名服务器响应内容标签,仅当状态为"success"时使用
<Servers></Servers>已设置的服务器信息
<Server></Server>每个服务器
<ServerName></ServerName>服务器名称
<ServerId></ServerId>服务器ID

设置文件夏例子

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetFolderNsResponse>
  <SetFolderNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderNsHeader>
  <SetFolderNsContent>
    <Servers>
      <Server>
        <ServerName>ns1.hosts.com</ServerName>
        <ServerId>0</ServerId>
      </Server>
      <Server>
        <ServerName>ns2.hosts.com</ServerName>
        <ServerId>1</ServerId>
      </Server>
    </Servers>
  </SetFolderNsContent>
</SetFolderNsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
Response (JSON format)
{
  "SetFolderNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetFolderNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}
 

设置文件夹停放命令

Support multi-thread

如果发送设置文件夹停放命令,则须包含下列参数:

设置文件夹停放请求参数
解释
folder_id您要设置的文件夹ID,每个请求可设置1个文件夹
with_ads (可选)如果您不想要第三方广告,则可将此参数设置为"no",,默认值为"yes"
enable (可选)如果您想为未来移动至此文件夹的域名应用此停放设置,则可将此参数设为"yes"
sync (可选)如果您想将此文件夹内所有域名的停放设置同步,则可将此参数设为"yes"
XML结果标签
解释
<SetFolderParkingResponse></SetFolderParkingResponse>响应XML文档的根节点
<SetFolderParkingHeader></SetFolderParkingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Folder Parking Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_parking&folder_id=0&with_ads=no
Response (XML format)
<SetFolderParkingResponse>
  <SetFolderParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderParkingHeader>
</SetFolderParkingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_parking&folder_id=0&with_ads=no
Response (JSON format)
{
   "SetFolderParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹转发命令

Support multi-thread

如果发送设置文件夹转发命令,则须包含下列参数:

设置文件夹转发请求参数
解释
folder_id您要设置的文件夹ID
forward_url您希望域名转发至的URL地址。请注意,参数必须为已编码,以便API调用可得到正确解析。
is_temp (可选)您要跳转域名的跳转状态,默认值为"temporary",,若您要永久跳转,则可将此参数设为"no"
enable (可选)如果您要将此跳转设置应用于今后移动至该文件夹的域名,则可将此参数设为"yes"
sync (可选)如果您要为此文件夹内所有域名同步跳转设置,则可将此参数设为"yes"
XML结果标签
解释
<SetFolderForwardingResponse></SetFolderForwardingResponse>响应XML文档的根节点
<SetFolderForwardingHeader></SetFolderForwardingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Folder Forwarding Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
Response (XML format)
<SetFolderForwardingResponse>
  <SetFolderForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderForwardingHeader>
</SetFolderForwardingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
Response (JSON format)
{
   "SetFolderForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹隐身命令

Support multi-thread

如果发送设置文件夹隐身命令,则须包含下列参数:

设置文件夹隐身请求参数
解释
folder_id您要设置的文件夹ID
stealth_url您希望域名转发至的URL地址。请注意,参数必须为已编码,以便API调用可得到正确解析。
stealth_title (可选)页面标题
enable (可选)如果您要将此隐身设置应用于今后移动至该文件夹的域名,则可将此参数设为"yes"
sync (可选)如果您要将此隐身设置同步于今后移动至该文件夹的所有域名,则可将此参数设为"yes"
XML结果标签
解释
<SetFolderStealthResponse></SetFolderStealthResponse>响应XML文档的根节点
<SetFolderStealthHeader></SetFolderStealthHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Folder Stealth Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes
Response (XML format)
<SetFolderStealthResponse>
  <SetFolderStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderStealthHeader>
</SetFolderStealthResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes
Response (JSON format)
{
   "SetFolderStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹托管命令

Support multi-thread

如果发送设置文件夹托管命令,则须包含下列参数:

设置文件夹托管请求参数
解释
folder_id您要设置的文件夹ID
hosting_type您想要的托管类型,可选择"advanced"和"basic"
enable (可选)如果您要将此托管设置应用于今后移动至该文件夹的域名,则可将此参数设为"yes"
even (可选)如果您想为在此文件夹下所有的域名同步托管设置,则可将次参数设为"yes"
XML结果标签
解释
<SetFolderHostingResponse></SetFolderHostingResponse>响应XML文档的根节点
<SetFolderHostingHeader></SetFolderHostingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Folder Hosting Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Response (XML format)
<SetFolderHostingResponse>
  <SetFolderHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHostingHeader>
</SetFolderHostingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Response (JSON format)
{
   "SetFolderHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹域名系统命令

Support multi-thread

如果要发送设置文件夹域名系统命令,则须包含下列参数:

这个命令已过时且不推荐使用,请改用设置文件夹DNS2命令。

设置文件夹DNS请求参数
解释
folder_id您要设置的文件夹ID
main_record_type主要记录类型
main_record为您的域名制定一个域名系统记录
main_record为您的域名制定一个域名系统记录
with_ads (可选)为您的域名指定TXT记录;若your main_record_type为aaaa,且指定了一个main_record2,则您可设置多达3个main_txts,否则,您可设置多达4个main_txts
main_record2主记录2,仅当"main_record_type"为"aaaa"时使用,其值必须为IPV4格式
subdomain0 - subdomain99 (可选)Subdomain records (可选)
sub_record_type0 - sub_record_type99 (可选)子域名记录类型
sub_record0 - sub_record99 (可选)IP地址或目标主机
mx_host0 - mx_host2 (可选)指定您域名的邮箱主机,distance0为最高优先级
mx_distance0 - mx_distance2 (可选)Distance0为最高优先级
ttl (可选)生存时间
enable (可选)如果您要将此DNS设置应用于今后您移动至此文件夹的域名,则可将此参数设为"yes"
sync (可选)如果您要将此DNS服务器设置同步于此文件夹中的所有域名,则可将此参数设为"yes"
XML结果标签
解释
<SetFolderDnsResponse></SetFolderDnsResponse>响应XML文档的根节点
<SetFolderDnsHeader></SetFolderDnsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Folder DNS Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Response (XML format)
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Response (JSON format)
{
   "SetFolderDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹DNS2命令

Support multi-thread

如果调用设置文件夹DNS2命令,应包含以下参数:

设置文件夹DNS2请求参数
解释
folder_id您要设置的文件夹ID
main_record_type0 - main_record_type19主记录类型应为"a"、"aaaa"、"cname"、"forward"、"txt"、"mx"、"stealth"、"email"
main_record0 - main_record19为您的域名指定DNS记录
main_recordx0 - main_recordx19Mx距离、转发类型、隐形转发标题或电子邮件别名当sub_record_type为"forward"、"mx"、"stealth"、"email"时必须提供
subdomain0 - subdomain99 (可选)Subdomain records (可选)
sub_record_type0 - sub_record_type99 (可选)子域名记录类型应为"a"、"aaaa"、"cname"、"forward"、"txt"、"srv"、"mx"、"stealth"、"email"
sub_record0 - sub_record99 (可选)IP地址或目标主机
sub_recordx0 - sub_recordx99 (可选)Mx距离、转发类型、隐形转发标题或电子邮件别名当sub_record_type为"forward"、"mx"、"stealth"、"email"时必须提供
ttl (可选)生存时间
enable (可选)如果您要将此DNS设置应用于今后您移动至此文件夹的域名,则可将此参数设为"yes"
sync (可选)如果您要将此DNS服务器设置同步于此文件夹中的所有域名,则可将此参数设为"yes"
XML结果标签
解释
<SetFolderDnsResponse></SetFolderDnsResponse>响应XML文档的根节点
<SetFolderDnsHeader></SetFolderDnsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Folder DNS2 Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Response (XML format)
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Response (JSON format)
{
   "SetFolderDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹电子邮件转发命令

Support multi-thread

如果发送设置文件夹电子邮件转发命令,则须包含下列参数:

设置文件夹电子邮件转发请求参数
解释
domain您要设置的域名,每个请求仅可设置100个域名,请务必用逗号将其隔开
folder_id您想设置的文件夹ID
forward_type转发类型,可以是"donot"::不要转发邮件;"mx":将邮件转发给另一个邮箱主机(MX记录);"forward"::将邮件转发给另一个邮箱主机
username0 - username9用户名,仅"forward_type"为"forward"时使用
exist_email0 - exist_email9现有电子邮箱地址,仅当"forward_type"为"forward"时使用
mx_host0 - mx_host2邮箱主机,仅"forward_type"为"mx"时使用
mx_distance0 - mx_distance2Distance0为最高优先级,仅当"forward_type"为"mx"时使用
enable (可选)如果您要将此设置应用于今后移动至该文件夹的域名,则可将此参数设为"yes"
sync (可选)如果您要将此设置同步于此文件夹中的所有域名,则可将此参数设为"yes"
XML结果标签
解释
<SetFolderEmailForwardingResponse></SetFolderEmailForwardingResponse>响应XML文档的根节点
<SetFolderEmailForwardingHeader></SetFolderEmailForwardingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Folder Email Forward Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
Response (XML format)
<SetFolderEmailForwardingResponse>
  <SetFolderEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderEmailForwardingHeader>
</SetFolderEmailForwardingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
Response (JSON format)
{
   "SetFolderEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置清除文件夹设置命令

Support multi-thread

如果发送设置清除文件夹设置命令,则须包含下列参数:

设置清除文件夹设置请求参数
解释
folder_id您要设置的文件夹ID
service您要清除的服务,它可以是“转发”、“隐形”、“电子邮件转发”、“dns”和“名字服务器”
XML结果标签
解释
<SetClearFolderSettingResponse></SetClearFolderSettingResponse>响应XML文档的根节点
<SetClearFolderSettingHeader></SetClearFolderSettingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Clear Folder Setting Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
Response (XML format)
<SetClearFolderSettingResponse>
  <SetClearFolderSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearFolderSettingHeader>
</SetClearFolderSettingResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
Response (JSON format)
{
   "SetClearFolderSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹名称命令

Support multi-thread

如果发送设置文件夹名称命令,则须包含下列参数:

设置文件夹名称请求参数
解释
folder_id您要设置文件夹的ID
folder_name新文件夹名称
XML结果标签
解释
<SetFolderNameResponse></SetFolderNameResponse>响应XML文档的根节点
<SetFolderNameHeader></SetFolderNameHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Set Folder Name Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new
Response (XML format)
<SetFolderNameResponse>
  <SetFolderNameHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderNameHeader>
</SetFolderNameResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new
Response (JSON format)
{
   "SetFolderNameResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹续费选项命令

Support multi-thread

如果发送设置文件夹续费选项命令,则须包含下列参数:

设置文件夹续费选项请求参数
解释
folder_id您要设置的文件夹ID,每个请求可设置1个文件夹
renew_option您要为文件夹设置的续订选项;它可以是 "不要续订"、"自动续订"或"重置"。
enable (可选)如果您要将此续费设置应用于今后您移动至此文件夹的域名,则可将此参数设为"yes"
sync (可选)如果您要将此续费设置同步于该文件夹中的所有域名,则可将此参数设为"yes"
XML结果标签
解释
<Response></Response>响应XML文档的根节点
<ResponseHeader></ResponseHeader>响应标头
<ResponseCode></ResponseCode>响应码,"0"为成功,"-1"为失败
<Error></Error>错误信息,仅当响应码为"-1"时使用
Set Folder Renew Option Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
Response (XML format)
<SetFolderRenewOptionResponse>
  <SetFolderRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderRenewOptionHeader>
</SetFolderRenewOptionResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
Response (JSON format)
{
   "SetFolderRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

文件夹列表命令

Support multi-thread

此命令仅适用于XML和JSON格式:

文件夹列表请求参数
解释
N/A无需额外参数
<FolderListResponse></FolderListResponse>响应XML文档的根节点
<FolderListHeader></FolderListHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<FolderListContent></FolderListContent>响应内容
<FolderList></FolderList>文件夹列表
<List></List>
<Folder></Folder>
<FolderId></FolderId>文件夹ID
<FolderName></FolderName>文件夹名称
<DefaultWhois></DefaultWhois>默认Whois
<DefaultWhoisEnableStatus></DefaultWhoisEnableStatus>默认Whois启用状态
<DefaultRegistrant></DefaultRegistrant>默认注册人
<ContactId></ContactId>联络人ID
<DefaultAdmin></DefaultAdmin>默认管理员
<DefaultTechnical></DefaultTechnical>默认技术信息
<DefaultBilling></DefaultBilling>默认账单信息
<DefaultNameServerEnableStatus></DefaultNameServerEnableStatus>默认域名服务器启用状态
<NameServerSettings></NameServerSettings>域名服务器设置
<Type></Type>域名服务器类型
<WithAds></WithAds>是否带有广告
<DefaultRenewOption></DefaultRenewOption>默认续费选项
<DefaultRenewOptionEnableStatus></DefaultRenewOptionEnableStatus>默认续费启用状态
<RenewOption></RenewOption>续费选项
<DefaultTransferLock></DefaultTransferLock>默认转移锁定
<DefaultTransferLockEnableStatus></DefaultTransferLockEnableStatus>默认转移锁定启用状态
<LockStatus></LockStatus>锁定状态
Folder List Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=folder_list
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<FolderListResponse>
  <FolderListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </FolderListHeader>
  <FolderListContent>
    <FolderList>
      <List>
        <Folder>
          <FolderId>0</FolderId>
          <FolderName>new</FolderName>
          <DefaultWhois>
            <DefaultWhoisEnableStatus>disable</DefaultWhoisEnableStatus>
            <DefaultRegistrant>
              <ContactId>0</ContactId>
            </DefaultRegistrant>
            <DefaultAdmin>
              <ContactId>0</ContactId>
            </DefaultAdmin>
            <DefaultTechnical>
              <ContactId>0</ContactId>
            </DefaultTechnical>
            <DefaultBilling>
              <ContactId>0</ContactId>
            </DefaultBilling>
          </DefaultWhois>
          <DefaultNameServers>
            <DefaultNameServerEnableStatus>disable</DefaultNameServerEnableStatus>
            <NameServerSettings>
              <Type>Dynadot Parking</Type>
              <WithAds>Yes</WithAds>
            </NameServerSettings>
          </DefaultNameServers>
          <DefaultRenewOption>
            <DefaultRenewOptionEnableStatus>disable</DefaultRenewOptionEnableStatus>
            <RenewOption>no renew option</RenewOption>
          </DefaultRenewOption>
          <DefaultTransferLock>
            <DefaultTransferLockEnableStatus>disable</DefaultTransferLockEnableStatus>
            <LockStatus>locked</LockStatus>
          </DefaultTransferLock>
        </Folder>
      </List>
    </FolderList>
  </FolderListContent>
</FolderListResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=folder_list
Response (JSON format)
{
  "FolderListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "FolderList": [
      {
        "FolderId": "0",
        "FolderName": "new",
        "DefaultWhois": {
          "DefaultWhoisEnableStatus": "disable",
          "DefaultRegistrant": {
            "ContactId": "0"
          },
          "DefaultAdmin": {
            "ContactId": "0"
          },
          "DefaultTechnical": {
            "ContactId": "0"
          },
          "DefaultBilling": {
            "ContactId": "0"
          }
        },
        "DefaultNameServers": {
          "DefaultTransferLockEnableStatus": "disable",
          "NameServerSettings": {
            "Type": "Dynadot Parking",
            "WithAds": "Yes"
          }
        },
        "DefaultRenewOption": {
          "DefaultRenewOptionEnableStatus": "disable",
          "RenewOption": "no renew option"
        },
        "DefaultTransferLock": {
          "DefaultTransferLockEnableStatus": "disable",
          "LockStatus": "locked"
        }
      }
    ]
  }
}
 

添加域名抢购请求命令

Support multi-thread

如添加域名抢购请求命令,则须包括下列参数:

添加域名抢购请求请求参数
解释
domain若Dynadot成功接取,您愿意添加并付款的一个或多个域名,每条请求可添加100个域名,请用逗号隔开
XML结果标签
解释
<AddBackorderRequestResponse></AddBackorderRequestResponse>响应XML文档的根节点
<AddBackorderRequestHeader></AddBackorderRequestHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Add Backorder Request Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Response (XML format)
<AddBackorderRequestResponse>
  <AddBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddBackorderRequestHeader>
</AddBackorderRequestResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Response (JSON format)
{
   "AddBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

删除域名抢购请求命令

Support multi-thread

如设置删除域名抢购请求命令,则需包含下列参数:

删除域名抢购请求请求参数
解释
domain您要从过期域名抢注请求清单中移除的(一个或多个域名),每个请求可移除100个域名,域名之间应使用逗号隔开
XML结果标签
解释
<DeleteBackorderRequestResponse></DeleteBackorderRequestResponse>响应XML文档的根节点
<DeleteBackorderRequestHeader></DeleteBackorderRequestHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Delete Backorder Request Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_backorder_request&domain=domaindropp.com
Response (XML format)
<DeleteBackorderRequestResponse>
  <DeleteBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteBackorderRequestHeader>
</DeleteBackorderRequestResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_backorder_request&domain=domaindropp.com
Response (JSON format)
{
   "DeleteBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

域名抢购请求列表命令

Support multi-thread

呼叫域名过期抢注请求清单命令将返回一个指定账户域名过期抢注请求清单;如果呼叫该命令,则需包含以下参数:

域名抢购请求列表请求参数
解释
startDate您要请求拍卖的过期抢注起始日期,如yyyy-mm-dd,如2015-05-05
endDate您要请求拍卖的过期抢注截止日期,yyyy-mm-dd,如2015-05-05
XML结果标签
解释
<BackorderRequestListResponse></BackorderRequestListResponse>响应XML文档的根节点
<BackorderRequestListHeader></BackorderRequestListHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<BackorderRequestListContent></BackorderRequestListContent>响应内容
<BackorderRequestList></BackorderRequestList>域名抢购请求列表
<BackorderRequest></BackorderRequest>域名抢购请求
<Domain></Domain>您列表上的域名
<CutoffTime></CutoffTime>以Unix时间计的删除请求交割日期(毫秒,自UTC1970年1月1日午夜起)
<BackorderRequestStatus></BackorderRequestStatus>过期抢购进程状态

域名抢购请求列表示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<BackorderRequestListResponse>
  <BackorderRequestListHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </BackorderRequestListHeader>
  <BackorderRequestListContent>
    <BackorderRequestList>
      <BackorderRequest>
        <DomainName>testdrop.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop3.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop4.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop5.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
    </BackorderRequestList>
  </BackorderRequestListContent>
</BackorderRequestListResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Response (JSON format)
{
  "BackorderRequestListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BackorderRequestList": [
      {
        "DomainName": "testdrop.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop3.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop4.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop5.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      }
    ]
  }
}
Request 领域行业相关的专业要求。https://api.dynadot.com/api3.html?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Response 领域行业相关的专业要求。
ok,success,Domain,CutoffTime,BackorderRequestStatus,testdrop.com,1403914140000,Active,testdrop3.com,1403914140000,Active,testdrop4.com,1403914140000,Active,testdrop5.com,1403914140000,Active
 

获取公开拍卖命令

Support multi-thread

呼叫获取公开拍卖命令将返回一个正在处理中的拍卖的清单;如果呼叫此命令,则应包含以下参数:

获取公开拍卖请求参数
解释
currency (可选)返回货币结果,应为"usd", "eur", 或 "cny",,默认货币为美元
type您想查看的拍卖类型应该是"expired", "user", "backorder", 或 "registry_expired", "registrar",,如果您想获取多种拍卖类型,可以使用","来分隔每种拍卖类型。
XML结果标签
解释
<GetOpenAuctionsResponse></GetOpenAuctionsResponse>获取公开拍卖响应标签,它是响应XML文档的根节点
<GetOpenAuctionsHeader></GetOpenAuctionsHeader>获取公开拍卖标题
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<GetOpenAuctionsContent></GetOpenAuctionsContent>公开拍卖内容标签,仅当状态为"success"时使用
<Auction></Auction>拍卖项目标签,仅状态为"success"时使用
<AuctionId></AuctionId>拍卖ID
<Domain></Domain>拍卖的域名
<BidPrice></BidPrice>拍卖目前竞标价格
<BidPriceCurrency></BidPriceCurrency>竞拍价格货币
<Bids></Bids>竞拍出价次数
<EndTime></EndTime>拍卖结束时间
<EndTimestamp></EndTimestamp>拍卖终止日期,以Unix时间计(毫秒,自UTC1970年一月1日午夜起)
<Revenue></Revenue>拍卖收入
<RevenueCurrency></RevenueCurrency>收入货币
<Visitors></Visitors>域名访客
<Links></Links>到达域名链接
<Age></Age>域名年龄
Get Open Auctions Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_open_auctions&currency=usd&type=expired
Response (XML format)
<GetOpenAuctionsResponse>
  <GetOpenAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetOpenAuctionsHeader>
  <GetOpenAuctionsContent>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
            <Revenue>72</Revenue>
            <RevenueCurrency>USD</RevenueCurrency>
            <Visitors>-1</Visitors>
            <Links>-1</Links>
            <Age>1</Age>
    </Auction>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
            <Revenue>72</Revenue>
            <RevenueCurrency>USD</RevenueCurrency>
            <Visitors>-1</Visitors>
            <Links>-1</Links>
            <Age>1</Age>
    </Auction>
    .
    .
    .
  </GetOpenAuctionsContent>
</GetOpenAuctionsResponse>
请求(csv格式)

https://api.dynadot.com/api3.html?key=mykey&command=get_open_auctions¤cy=usd&type=expired

响应

ok,
success,
AuctionId,Domain,BidPrice,BidPriceCurrency,Bids,EndTime,EndTimestamp,Revenue,RevenueCurrency,Visitors,Links,Age
10001,domain.com,92.99,USD,0,2015/04/28 18:04 UTC,1430244248274,0.64,USD,-1,-1,1
10002,xn--wkccg.com,77.99,USD,0,2015/05/01 06:04 UTC,1430460248338,86,USD,435,-1,1
10003,domain2.com,11.25,USD,0,2015/05/05 06:04 UTC,1430805846946,91,USD,358,-1,1
.
.
.

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_open_auctions&currency=usd&type=expired
Response (JSON format)
{
    "status": "success",
    "auction_list": [
        {
            "auction_id": 11,
            "domain": "domain.com",
            "utf_name": "domain.com",
            "is_idn": false,
            "auction_type": "expired",
            "currency": "USD",
            "current_bid_price": "124.00",
            "bids": 4,
            "bidders": 2,
            "time_left": "1 day, 23 hours",
            "start_time": "2022/03/28 02:20 PST",
            "start_time_stamp": 1648459234033,
            "end_time": "2022/04/04 02:20 PST",
            "end_time_stamp": 1649064034033,
            "visitors": 223,
            "links": "-",
            "age": 0,
            "estibot_appraisal": "-"
        },
        {
            "auction_id": 12,
            "domain": "domain0.com",
            "utf_name": "domain0.com",
            "is_idn": false,
            "auction_type": "expired",
            "currency": "USD",
            "current_bid_price": "44.99",
            "bids": 1,
            "bidders": 1,
            "time_left": "2 days, 23 hours",
            "start_time": "2022/03/29 02:20 PST",
            "start_time_stamp": 1648545634049,
            "end_time": "2022/04/05 02:20 PST",
            "end_time_stamp": 1649150434049,
            "visitors": 245,
            "links": "-",
            "age": 0,
            "estibot_appraisal": "-"
        }
        ...
    ]
}
 

获取拍卖详情命令

Support multi-thread

调用获取拍卖详细信息命令将返回指定拍卖的详细信息。此命令仅以XML和JSON格式提供。如果调用此命令,应包括以下参数:

获取拍卖详情请求参数
解释
domain拍卖的域名,IDN(国际域名)应使用punycode,例如“xn--wkccg.com”。您可以获得多个拍卖,每个域名必须用“,”分隔
currency (可选)返回货币结果,应为"usd", "eur", 或 "cny",,默认货币为美元
XML结果标签
解释
<GetAuctionDetailsResponse></GetAuctionDetailsResponse>获取拍卖详情响应标签,它是XML文档响应的根节点
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>获取过期域名竞拍详情标题
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<GetAuctionDetailsContent></GetAuctionDetailsContent>获取拍卖细节内容标签,仅当状态为"success"时可用
<AuctionStatusId></AuctionStatusId>拍卖状态 ID:'0' 表示进行中,'1' 表示用户取消,'2' 表示管理员取消,'3' 表示续订取消,'4' 表示完成,'5' 表示转移取消
<AuctionStatus></AuctionStatus>拍卖状态
<UserIsHighBid></UserIsHighBid>如果用户为出价最高者
<YourCurrentBid></YourCurrentBid>指定拍卖中您目前的竞拍出价;若尚未出价,则应为'-1'
<YourProxyBid></YourProxyBid>指定拍卖的代理竞拍;如果您尚未出价,应为'-1'
<AuctionId></AuctionId>拍卖ID
<Domain></Domain>拍卖的域名
<BidPrice></BidPrice>拍卖目前竞标价格
<BidPriceCurrency></BidPriceCurrency>竞拍价格货币
<Bids></Bids>竞拍出价次数
<EndTime></EndTime>拍卖结束时间
<EndTimestamp></EndTimestamp>拍卖终止日期,以Unix时间计(毫秒,自UTC1970年一月1日午夜起)
<IsPremium></IsPremium>无论是否为高端域名
<RenewalPrice></RenewalPrice>续费价格
Get Auction Details Example
Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetAuctionDetailsResponse>
  <GetAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAuctionDetailsHeader>
  <GetAuctionDetailsContent>
    <Auction>
      <AuctionStatusId>0</AuctionStatusId>
      <AuctionStatus>1</AuctionStatus>
      <AuctionId>0</AuctionId>
      <Domain>test.biz</Domain>
      <BidPrice>46.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>0</Bids>
      <EndTime>1970/01/01 00:00 UTC</EndTime>
      <EndTimestamp>0</EndTimestamp>
      <Revenue>1</Revenue>
      <RevenueCurrency>USD</RevenueCurrency>
      <Visitors>-1</Visitors>
      <Links>1</Links>
      <Age>10</Age>
      <isPremium>false</isPremium>
      <RenewalPrice>-0.1</RenewalPrice>
      <UserIsHighBid>false</UserIsHighBid>
      <YourCurrentBid>-1</YourCurrentBid>
      <YourProxyBid>-1</YourProxyBid>
    </Auction>
  </GetAuctionDetailsContent>
</GetAuctionDetailsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
Response (JSON format)
{
  "status": "success",
  "size": 1,
  "auction_details": [
    {
      "auction_json": {
        "auction_id": 0,
        "domain": "test.biz",
        "utf_name": "test.biz",
        "is_idn": false,
        "auction_type": "expired",
        "current_bid_price": "46.99",
        "accepted_bid_price": "46.99",
        "currency": "USD",
        "is_high_bidder": false,
        "bids": 0,
        "bidders": 0,
        "auction_status_id": 0,
        "time_left": "1",
        "start_time": "1",
        "start_time_stamp": 0,
        "end_time": "",
        "end_time_stamp": 0,
        "revenue": "1",
        "visitors": -1,
        "links": "1",
        "age": 10,
        "estibot_appraisal": "",
        "bidder_name": "",
        "bid_price": "",
        "timestamp": 0,
        "bid_status": "",
        "is_proxy_auto_bid": false,
        "auction_ended": false,
        "customer_bided": false,
        "customer_bid": "1",
        "customer_proxy_bid": "1",
        "is_premium": false,
        "renewal_price": "-0.1"
      },
      "bid_history": []
    }
  ]
}
 

获取竞拍出价(Get Auction Bids)命令

Support multi-thread

调用获取拍卖竞标命令将获取您参与的竞标列表。如果调用此命令,则必须包含以下参数:

获取拍卖竞标请求参数
解释
currency (可选)您竞拍的货币,应为"usd", "eur", 或 "cny",,默认货币为美元
XML结果标签
解释
<GetAuctionBidsResponse></GetAuctionBidsResponse>获取拍卖竞标响应的标记,它是响应XML文档的根节点
<GetAuctionBidsHeader></GetAuctionBidsHeader>获取拍卖竞标标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<GetAuctionBidsContent></GetAuctionBidsContent>获取拍卖竞标内容的标签,仅在状态为 "success" 时使用
<BidList></BidList>竞标清单
<Bid></Bid>竞标项
<BidId></BidId>竞标ID
<AuctionId></AuctionId>拍卖ID
<AccountId></AccountId>账户ID
<Domain></Domain>拍卖的域名
<DomainUtf></DomainUtf>域 utf 拍卖名称
<AuctionType></AuctionType>拍卖类型
<IsIdn></IsIdn>如果此域名是国际化域名
<CurrentBid></CurrentBid>拍卖的当前竞价价格
<YourStatus></YourStatus>您的拍卖竞标状态
<ProxyBid></ProxyBid>您的委托竞拍出价
<ActiveBidders></ActiveBidders>参加此次拍卖的竞标者数量
<TimeLeft></TimeLeft>拍卖剩余时间
<EndTime></EndTime>拍卖结束时间
<EndTimestamp></EndTimestamp>拍卖的结束时间戳
Get Auction Bids Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_auction_bids&ampcurrency=usd
Response (XML format)
<GetAuctionBidsResponse>
    <GetAuctionBidsHeader>
        <SuccessCode>0</SuccessCode>
        <Status>success</Status>
    </GetAuctionBidsHeader>
    <GetAuctionBidsContent>
        <BidList>
            <Bid>
                <BidId>0</BidId>
                <AuctionId>11</AuctionId>
                <AccountId>1</AccountId>
                <Domain>domain.com</Domain>
                <DomainUtf>domain.com</DomainUtf>
                <AuctionType>expired</AuctionType>
                <IsIdn>false</IsIdn>
                <CurrentBid>$124.00</CurrentBid>
                <YourStatus>Out Bid</YourStatus>
                <ProxyBid>$119.00</ProxyBid>
                <ActiveBidders>2</ActiveBidders>
                <TimeLeft>1 day, 6 hours</TimeLeft>
                <EndTime>2022/04/04 02:20:34 PST</EndTime>
                <EndTimestamp>1649064034033</EndTimestamp>
            </Bid>
            <Bid>
                <BidId>9</BidId>
                <AuctionId>12</AuctionId>
                <AccountId>1</AccountId>
                <Domain>domain0.com</Domain>
                <DomainUtf>domain0.com</DomainUtf>
                <AuctionType>expired</AuctionType>
                <IsIdn>false</IsIdn>
                <CurrentBid>$44.99</CurrentBid>
                <YourStatus>High Bidder</YourStatus>
                <ProxyBid>$121.00</ProxyBid>
                <ActiveBidders>1</ActiveBidders>
                <TimeLeft>2 days, 6 hours</TimeLeft>
                <EndTime>2022/04/05 02:20:34 PST</EndTime>
                <EndTimestamp>1649150434049</EndTimestamp>
            </Bid>
        </BidList>
    </GetAuctionBidsContent>
</GetAuctionBidsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_auction_bids&ampcurrency=usd
Response (JSON format)
{
    "status": "success",
    "auction_bids": [
        {
            "bid_id": 0,
            "auction_id": 11,
            "account_id": "1",
            "domain": "domain.com",
            "domain_utf": "domain.com",
            "auction_type": "expired",
            "is_idn": false,
            "current_bid": "$44.99",
            "your_status": "High Bidder",
            "proxy_bid": "$119.00",
            "active_bidders": 1,
            "time_left": "1 day, 23 hours",
            "end_time": "2022/04/04 02:20:34 PST",
            "end_time_stamp": 1649064034033
        },
        {
            "bid_id": 2,
            "auction_id": 12,
            "account_id": "1",
            "domain": "domain0.com",
            "domain_utf": "domain0.com",
            "auction_type": "expired",
            "is_idn": false,
            "current_bid": "$44.99",
            "your_status": "High Bidder",
            "proxy_bid": "$119.00",
            "active_bidders": 1,
            "time_left": "2 days, 23 hours",
            "end_time": "2022/04/05 02:20:34 PST",
            "end_time_stamp": 1649150434049
        }
        ...
    ]
}
 

竞拍出价命令

Support multi-thread

呼叫出价竞标命令将会为指定拍卖出价;若呼叫此命令,则应包含以下参数:

竞拍出价请求参数
解释
domain拍卖的域名、国际化域名应使用punycode,如"xn--wkccg.com"
bid_amount您的竞拍出价,默认货币为美元,您也可以指定货币类型
currency (可选)您竞拍的货币,应为"usd", "eur", 或 "cny",,默认货币为美元
XML结果标签
解释
<PlaceAuctionBidResponse></PlaceAuctionBidResponse>竞拍出价响应标签,它是响应XML文档的根节点
<PlaceAuctionBidHeader></PlaceAuctionBidHeader>竞拍出价标题
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Domain Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Response (XML format)
<PlaceAuctionBidResponse>
  <PlaceAuctionBidHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </PlaceAuctionBidHeader>
</PlaceAuctionBidResponse>
请求(csv格式)

https://api.dynadot.com/api3.html?key=mykey&command=place_auction_bid&domain=example.com&bid_amount=99.9¤cy=usd

响应

ok,success

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Response (JSON format)
{
    "status": "success",
    "auction_details": {
        "auction_json": {
            "auction_id": 12,
            "domain": "example.com",
            "utf_name": "example.com",
            "is_idn": false,
            "auction_type": "expired",
            "current_bid_price": "44.99",
            "accepted_bid_price": "45.99",
            "currency": "USD",
            "is_high_bidder": true,
            "bids": 3,
            "bidders": 2,
            "time_left": "2 days, 22 hours",
            "start_time": "2022/03/29 02:20 PST",
            "start_time_stamp": 1648545634049,
            "end_time": "2022/04/05 02:20 PST",
            "end_time_stamp": 1649150434049,
            "revenue": "$26.50",
            "visitors": 245,
            "links": "-",
            "age": 0,
            "estibot_appraisal": "-",
            "auction_ended": false,
            "customer_bided": true,
            "customer_bid": "44.99",
            "customer_proxy_bid": "$121.00"
        },
        "bid_history": [
            {
                "bidder_name": "You",
                "bid_price": "44.99",
                "currency": "USD",
                "timestamp": 1648892255084,
                "bid_status": "High Bidder",
                "is_proxy_auto_bid": false
            }
            ...        ]
    }
}
 

获取已关闭拍卖命令

Support multi-thread

调用获取已关闭竞拍命令将返回指定账户的已关闭竞拍列表。如果调用该命令,应包含以下参数:

获取已关闭拍卖请求参数
解释
startDate拍卖起始日期,yyyy-mm-dd,如2015-05-05
endDate拍卖结束日期,yyyy-mm-dd,如2015-05-05
currency (可选)您竞拍的货币,应为"usd", "eur", 或 "cny",,默认货币为美元
XML结果标签
解释
<GetClosedAuctionsResponse></GetClosedAuctionsResponse>获取已关闭拍卖响应标签,它是响应XML文档的根节点
<GetClosedAuctionsHeader></GetClosedAuctionsHeader>获取已关闭拍卖标题
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<GetClosedAuctionsContent></GetClosedAuctionsContent>获取已关闭拍卖内容标签,仅当状态为"success"时使用
<Auction></Auction>拍卖项目标签,仅状态为"success"时使用
<AuctionId></AuctionId>拍卖ID
<Domain></Domain>拍卖的域名
<AuctionStatusId></AuctionStatusId>拍卖状态ID,“0”为进行中,“1”为被用户关闭,“2”为被管理员关闭,“3”为因续费关闭,“4”为由于超时关闭,“5”为因迁出关闭
<AuctionStatus></AuctionStatus>拍卖状态
<BidPrice></BidPrice>拍卖目前竞标价格
<BidPriceCurrency></BidPriceCurrency>竞拍价格货币
<Bids></Bids>竞拍出价次数
<AuctionWonStatus></AuctionWonStatus>如果用户在拍卖中胜出
<YourHighBid></YourHighBid>您对该竞拍的高出价
<YourProxyBid></YourProxyBid>对此拍卖的代理竞拍出价

获取已关闭拍卖示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetClosedAuctionsResponse>
  <GetClosedAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedAuctionsHeader>
  <GetClosedAuctionsContent>
    <Auction>
      <AuctionId>2</AuctionId>
      <Domain>testdomain1.test</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
    </Auction>
    <Auction>
      <AuctionId>3</AuctionId>
      <Domain>testdomain2.test</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
    </Auction>
  </GetClosedAuctionsContent>
</GetClosedAuctionsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Response (JSON format)
{
  "GetClosedAuctionsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Auctions": [
      {
        "AuctionId": "2",
        "Domain": "testdomain1.test",
        "AuctionStatusId": "4",
        "AuctionStatus": "Closed by Timeout",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "AuctionWonStatus": "won",
        "YourHighBid": "89.99",
        "YourProxyBid": "1000.0"
      },
      {
        "AuctionId": "3",
        "Domain": "testdomain2.test",
        "AuctionStatusId": "4",
        "AuctionStatus": "Closed by Timeout",
        "BidPrice": "28.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "AuctionWonStatus": "won",
        "YourHighBid": "28.99",
        "YourProxyBid": "1000.0"
      }
    ]
  }
}
Request 领域行业相关的专业要求。https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Response 领域行业相关的专业要求。
ok,success,AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid,2,testdomain1.test,4,Closed by Timeout,89.99,USD,1,won,89.99,1000.0,3,testdomain2.test,4,Closed by Timeout,28.99,USD,1,won,28.99,1000.0
 

获取开放过期域名竞拍命令(已弃用,请使用get_open_auctions命令)

Support multi-thread

调用获取开放过期域名竞拍命令将返回正在进行中的过期域名竞拍列表。如果调用此命令,应包含以下参数:

获取开放过期域名竞拍请求参数
解释
currency (可选)返回货币结果,应为"usd", "eur", 或 "cny",,默认货币为美元
XML结果标签
解释
<GetOpenBackorderAuctionsResponse></GetOpenBackorderAuctionsResponse>获取开放过期域名竞拍响应标签,将作为响应XML文件的根节点
<GetOpenBackorderAuctionsHeader></GetOpenBackorderAuctionsHeader>获取开放过期域名竞拍标题
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<GetOpenBackorderAuctionsContent></GetOpenBackorderAuctionsContent>获取开放过期域名竞拍内容标签,只在状态为"success"时使用
<Auction></Auction>拍卖项目标签,仅状态为"success"时使用
<AuctionId></AuctionId>拍卖ID
<Domain></Domain>拍卖的域名
<BidPrice></BidPrice>拍卖目前竞标价格
<BidPriceCurrency></BidPriceCurrency>竞拍价格货币
<Bids></Bids>竞拍出价次数
<EndTime></EndTime>拍卖结束时间
<EndTimestamp></EndTimestamp>拍卖终止日期,以Unix时间计(毫秒,自UTC1970年一月1日午夜起)
Get Open Backorder Auctions Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_open_backorder_auctions&currency=usd
Response (XML format)
<GetOpenBackorderAuctionsResponse>
  <GetOpenBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetOpenBackorderAuctionsHeader>
  <GetOpenBackorderAuctionsContent>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
    </Auction>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
    </Auction>
    .
    .
    .
  </GetOpenBackorderAuctionsContent>
</GetOpenBackorderAuctionsResponse>
请求(csv格式)

https://api.dynadot.com/api3.html?key=mykey&command=get_open_backorder_auctions¤cy=usd

响应

ok,
success,
AuctionId,Domain,BidPrice,BidPriceCurrency,Bids,EndTime,EndTimestamp
10000,backorder0.com,6.35,USD,0,2017/08/29 17:53 UTC,1504029194453
10001,backorder1.com,1.0,USD,0,2017/08/29 17:53 UTC,1504029194453
10002,backorder2.com,1.0,USD,0,2017/08/29 17:53 UTC,1504029194453
.
.
.

 

获取过期域名竞拍详情命令

Support multi-thread

调用获取委托拍卖明细命令将返回指定拍卖的详细信息。此命令仅适用于XML和JSON格式。如果调用此命令,则应包括以下参数:

获取拍卖详情请求参数
解释
domain过期域名竞拍中的域名,IDN(国际域名)应使用域名代码(punycode),例如“xn--wkccg.com”
currency (可选)返回货币结果,应为"usd", "eur", 或 "cny",,默认货币为美元
XML结果标签
解释
<GetBackorderAuctionDetailsResponse></GetBackorderAuctionDetailsResponse>获取拍卖详情响应标签,它是XML文档响应的根节点
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>获取拍卖详情标题
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<GetAuctionDetailsContent></GetAuctionDetailsContent>获取拍卖细节内容标签,仅当状态为"success"时可用
<AuctionStatusId></AuctionStatusId>拍卖状态ID,“0”为进行中,“1”为被用户关闭,“2”为被管理员关闭,“3”为因续费关闭,“4”为由于超时关闭,“5”为因迁出关闭
<AuctionStatus></AuctionStatus>拍卖状态
<AuctionId></AuctionId>拍卖ID
<Domain></Domain>拍卖的域名
<BidPrice></BidPrice>拍卖目前竞标价格
<BidPriceCurrency></BidPriceCurrency>竞拍价格货币
<Bids></Bids>竞拍出价次数
<EndTime></EndTime>拍卖结束时间
<EndTimestamp></EndTimestamp>拍卖终止日期,以Unix时间计(毫秒,自UTC1970年一月1日午夜起)
<Revenue></Revenue>拍卖收入
<RevenueCurrency></RevenueCurrency>收入货币
<Visitors></Visitors>域名访客
<Links></Links>到达域名链接
<Age></Age>域名年龄
<UserIsHighBid></UserIsHighBid>如果用户为出价最高者
<YourCurrentBid></YourCurrentBid>指定拍卖中您目前的竞拍出价;若尚未出价,则应为'-1'
<YourProxyBid></YourProxyBid>指定拍卖的代理竞拍;如果您尚未出价,应为'-1'
Get Backorder Auction Details Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetBackorderAuctionDetailsResponse>
  <GetBackorderAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetBackorderAuctionDetailsHeader>
  <GetBackorderAuctionDetailsContent>
    <AuctionStatusId>0</AuctionStatusId>
    <AuctionStatus>In Progress</AuctionStatus>
    <UserIsHighBid>no</UserIsHighBid>
    <YourCurrentBid>-1</YourCurrentBid>
    <YourProxyBid>-1</YourProxyBid>
    <Auction>
      <AuctionId>10001</AuctionId>
      <Domain>example.com</Domain>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>0</Bids>
      <EndTime>2015/04/28 18:16 UTC</EndTime>
      <EndTimestamp>1430244969779</EndTimestamp>
    </Auction>
  </GetBackorderAuctionDetailsContent>
</GetBackorderAuctionDetailsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
Response (JSON format)
{
  "GetBackorderAuctionDetailsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetBackorderAuctionDetails": {
      "AuctionStatusId": "0",
      "AuctionStatus": "In Progress",
      "UserIsHighBid": "no",
      "YourCurrentBid": "-1",
      "YourProxyBid": "-1",
      "Auction": {
        "AuctionId": "10001",
        "Domain": "example.com",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "0",
        "EndTime": "2015/04/28 18:16 UTC",
        "EndTimestamp": "1430244969779"
      }
    }
  }
}
 

过期域名竞拍出价命令

Support multi-thread

调用过期域名竞拍出价命令将对指定的过期域名竞拍进行报价。如果调用该命令,应包含以下参数:

过期域名竞拍出价请求参数
解释
domain拍卖的域名、国际化域名应使用punycode,如"xn--wkccg.com"
bid_amount您的竞拍出价,默认货币为美元,您也可以指定货币类型
currency (可选)您竞拍的货币,应为"usd", "eur", 或 "cny",,默认货币为美元
XML结果标签
解释
<PlaceBakcorderAuctionBidResponse></PlaceBakcorderAuctionBidResponse>竞拍出价响应标签,它是响应XML文档的根节点
<PlaceBackorderAuctionBidHeader></PlaceBackorderAuctionBidHeader>竞拍出价标题
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
Place Backorder Auction Bid Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Response (XML format)
<PlaceBakcorderAuctionBidResponse>
 <PlaceBackorderAuctionBidHeader>
   <SuccessCode>0</SuccessCode>
   <Status>success</Status>
 </PlaceBackorderAuctionBidHeader>
</PlaceBakcorderAuctionBidResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Response (JSON format)
{
   "PlaceBakcorderAuctionBidResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
Request 领域行业相关的专业要求。https://api.dynadot.com/api3.html?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Response 领域行业相关的专业要求。
ok,success
 

获取已关闭过期域名竞拍命令

Support multi-thread

调用获取已关闭过期域名命令将返回指定账户的已关闭过期域名竞拍列表。如果调用该命令,应包含以下参数:

获取已关闭的过期域名竞拍请求参数
解释
startDate拍卖起始日期,yyyy-mm-dd,如2015-05-05
endDate拍卖结束日期,yyyy-mm-dd,如2015-05-05
currency (可选)您竞拍的货币,应为"usd", "eur", 或 "cny",,默认货币为美元
XML结果标签
解释
<GetClosedBackorderAuctionsResponse></GetClosedBackorderAuctionsResponse>获取已关闭拍卖响应标签,它是响应XML文档的根节点
<GetClosedBackorderAuctionsHeader></GetClosedBackorderAuctionsHeader>获取已关闭拍卖标题
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<GetClosedBackorderAuctionsContent></GetClosedBackorderAuctionsContent>获取已关闭拍卖内容标签,仅当状态为"success"时使用
<Auction></Auction>拍卖项目标签,仅状态为"success"时使用
<YourHighBid></YourHighBid>您对该竞拍的高出价
<YourProxyBid></YourProxyBid>对此拍卖的代理竞拍出价
<AuctionId></AuctionId>拍卖ID
<Domain></Domain>拍卖的域名
<AuctionStatusId></AuctionStatusId>拍卖状态ID,“0”为进行中,“1”为被用户关闭,“2”为被管理员关闭,“3”为因续费关闭,“4”为由于超时关闭,“5”为因迁出关闭
<AuctionStatus></AuctionStatus>拍卖状态
<BidPrice></BidPrice>拍卖目前竞标价格
<BidPriceCurrency></BidPriceCurrency>竞拍价格货币
<Bids></Bids>竞拍出价次数

获取已关闭的备货拍卖示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetClosedBackorderAuctionsResponse>
  <GetClosedBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedBackorderAuctionsHeader>
  <GetClosedBackorderAuctionsContent>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>2</AuctionId>
      <Domain>testdomain1.test</Domain>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <EndTime>2022/04/04 02:20:34 PST</EndTime>
      <EndTimestamp>1649064034033</EndTimestamp>
    </Auction>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>3</AuctionId>
      <Domain>testdomain2.test</Domain>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <EndTime>2022/04/05 02:20:34 PST</EndTime>
      <EndTimestamp>1649150434049</EndTimestamp>
    </Auction>
  </GetClosedBackorderAuctionsContent>
</GetClosedBackorderAuctionsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Response (JSON format)
{
  "GetClosedBackorderAuctionsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Auctions": [
      {
        "AuctionWonStatus": "won",
        "YourHighBid": "89.99",
        "YourProxyBid": "1000.0",
        "AuctionId": "2",
        "Domain": "testdomain1.test",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "EndTime": "2022/04/04 02:20:34 PST",
        "EndTimestamp": "1649064034033"
      },
      {
        "AuctionWonStatus": "won",
        "YourHighBid": "28.99",
        "YourProxyBid": "1000.0",
        "AuctionId": "3",
        "Domain": "testdomain2.test",
        "BidPrice": "28.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "EndTime": "2022/04/05 02:20:34 PST",
        "EndTimestamp": "1649150434049"
      }
    ]
  }
}
Request 领域行业相关的专业要求。https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Response 领域行业相关的专业要求。
ok,success,AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid,2,testdomain1.test,4,Closed by Timeout,89.99,USD,1,won,89.99,1000.0,3,testdomain2.test,4,Closed by Timeout,28.99,USD,1,won,28.99,1000.0
 

获取过期清仓域名命令

Support multi-thread

调用获取过期清算域名命令会获取过期清算域名。该命令仅适用于XML和JSON格式。如果调用该命令,应包括以下参数:

获取过期的清仓域名请求参数
解释
currency(optional)返回结果的货币应为"usd","eur"或"cny",默认货币为美元。
domain(optional)如果要查询清算域,请添加此参数
XML结果标签
解释
<GetExpiredCloseoutDomainsResponse></GetExpiredCloseoutDomainsResponse>Get Expired Closeout Domains的标签响应,是响应XML文档的根节点
<GetExpiredCloseoutDomainsHeader></GetExpiredCloseoutDomainsHeader>获取过期清仓域名标题
<ResponseCode></ResponseCode>如果操作成功,则为成功的"0",失败的"-1"
<Status></Status>请求状态
<Error></Error>请求的错误信息仅在状态为“错误”时使用
<GetExpiredCloseoutDomainsContent></GetExpiredCloseoutDomainsContent>内容标记,仅在状态为'成功'时使用
<CloseoutItem></CloseoutItem>清仓商品
<DomainName></DomainName>域名
<DomainNameUtf></DomainNameUtf>域名采用UTF格式
<CurrentPrice></CurrentPrice>当前价格
<isIdn></isIdn>无论是idn域名
<EndTimeStamp></EndTimeStamp>拍卖结束日期的Unix时间(自1970年1月1日UTC午夜以来的毫秒数)
<RenewalPrice></RenewalPrice>续费价格
<ExpiredRevenue></ExpiredRevenue>清仓收入
<EstibotAppraisal></EstibotAppraisal>Estibot评估
<InboundLinks></InboundLinks>到达域名链接
<MonthlyVisitors></MonthlyVisitors>域名访客
<Currency></Currency>货币
Get Expired Closeout Domains Example
Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetExpiredCloseoutDomainsResponse>
  <GetExpiredCloseoutDomainsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetExpiredCloseoutDomainsHeader>
  <GetExpiredCloseoutDomainsContent>
    <CloseoutItem>
      <DomainName>test.biz</DomainName>
      <DomainNameUtf>test.biz</DomainNameUtf>
      <CurrentPrice>9.91</CurrentPrice>
      <IsIDN>false</IsIDN>
      <EndTimeStamp>0</EndTimeStamp>
      <RenewalPrice>9.99</RenewalPrice>
      <ExpiredRevenue>9.90</ExpiredRevenue>
      <EstibotAppraisal>1223</EstibotAppraisal>
      <InboundLinks>-1</InboundLinks>
      <MonthlyVisitors>-1</MonthlyVisitors>
      <Currency>usd</Currency>
    </CloseoutItem>
  </GetExpiredCloseoutDomainsContent>
</GetExpiredCloseoutDomainsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
Response (JSON format)
{
  "GetExpiredCloseoutDomainsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Size": 1,
    "CloseoutDomains": [
      {
        "closeoutItem": {
          "domainName": "test.biz",
          "domainNameUtf": "test.biz",
          "currentPrice": "9.91",
          "isIdn": false,
          "endTimeStamp": 0,
          "renewalPrice": "9.99",
          "expiredRevenue": "9.90",
          "estibotAppraisal": "1223",
          "inboundLinks": -1,
          "monthlyVisitors": -1,
          "currency": "usd"
        }
      }
    ]
  }
}
 

购买已过期清货域名命令

Support multi-thread

调用购买过期清仓域名命令将购买指定的域名。此命令仅在XML和JSON格式中提供。如果调用此命令,应包括以下参数:

购买过期清仓域请求参数
解释
domain您想购买的域名,每个请求只能输入一个域名
currency(optional)返回结果的货币应为"usd","eur"或"cny",默认货币为美元。
XML结果标签
解释
<BuyExpiredCloseoutDomainResponse></BuyExpiredCloseoutDomainResponse>购买已过期的清仓域名的标签,它是响应文档XML的根节点。
<BuyExpiredCloseoutDomainHeader></BuyExpiredCloseoutDomainHeader>购买过期清仓域名头
<ResponseCode></ResponseCode>如果操作成功,则为成功的"0",失败的"-1"
<Status></Status>请求状态
<Error></Error>请求的错误信息仅在状态为“错误”时使用
Buy Expired Closeout Domain Example
Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<BuyExpiredCloseoutDomainResponse>
  <BuyExpiredCloseoutDomainHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BuyExpiredCloseoutDomainHeader>
</BuyExpiredCloseoutDomainResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
Response (JSON format)
{
  "BuyExpiredCloseoutDomainResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

获取列表命令

Support multi-thread

如果调用获取列表命令,则应包括以下参数:

获取列表请求参数
解释
currency (可选)返回货币结果,应为"usd", "eur", 或 "cny",,默认货币为美元
exclude_pending_sale (可选)如果您不想获得待售锁定列表,应该是"yes",默认值是"no"。
show_other_registrar (可选)如果您想获取其他注册商列表,则应为"yes",,默认值为"no"
XML结果标签
解释
<GetListingsResponse></GetListingsResponse>响应XML文件的根节点XML文件
<GetListingsHeader></GetListingsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<GetListingsContent></GetListingsContent>列出内容
<Listing></Listing>列出物品内容
<ListingId></ListingId>列表标识
<Domain></Domain>域名名称
<Price></Price>出售价格
<InBoundLinks></InBoundLinks>入站链接计数
<Age></Age>域名年龄
Get Listings Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&currency=usd&command=get_listings
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetListingsResponse>
  <GetListingsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetListingsHeader>
  <GetListingsContent>
    <Listing>
      <ListingId>id1</ListingId>
      <Domain>domain_name1</Domain>
      <Price>1</Price>
      <InboundLinks>1</InboundLinks>
      <Age>1</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
    <Listing>
      <ListingId>id2</ListingId>
      <Domain>domain_name2</Domain>
      <Price>2</Price>
      <InboundLinks>2</InboundLinks>
      <Age>2</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
  </GetListingsContent>
</GetListingsResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&currency=usd&command=get_listings
Response (JSON format)
{
  "GetListingsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Listing": [
      {
        "ListingId": "id1",
        "Domain": "domain_name1",
        "Price": "1",
        "InboundLinks": "1",
        "Age": "1",
        "PendingSaleLocked": "No"
      },
      {
        "ListingId": "id2",
        "Domain": "domain_name2",
        "Price": "2",
        "InboundLinks": "2",
        "Age": "2",
        "PendingSaleLocked": "No"
      }
    ]
  }
}
 

获取列表项命令

Support multi-thread

如果调用获取列表项命令,则应包括以下参数:

获取列表项请求参数
解释
domain您要获取详细信息的域名,每个请求只能输入一个1域名
currency (可选)返回货币结果,应为"usd", "eur", 或 "cny",,默认货币为美元
XML结果标签
解释
<GetListingItemResponse></GetListingItemResponse>响应XML文件的根节点XML文件
<GetListingItemHeader></GetListingItemHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<GetListingsItemContent></GetListingsItemContent>列出内容
<Listing></Listing>列出物品内容
<ListingId></ListingId>列表标识
<Domain></Domain>域名名称
<Price></Price>出售价格
<InBoundLinks></InBoundLinks>入站链接计数
<Age></Age>域名年龄
Get Listing Item Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_listing_item&currency=usd&domain=domain_name
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetListingsItemResponse>
  <GetListingsItemHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetListingsItemHeader>
  <GetListingsItemContent>
    <Listing>
      <ListingId>id</ListingId>
      <Domain>domain_name</Domain>
      <Price>0</Price>
      <InboundLinks>0</InboundLinks>
      <Age>0</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
  </GetListingsItemContent>
</GetListingsItemResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_listing_item&currency=usd&domain=domain_name
Response (JSON format)
{
  "GetListingsItemResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Listing": {
      "ListingId": "id",
      "Domain": "domain_name",
      "Price": "0",
      "InboundLinks": "0",
      "Age": "0",
      "PendingSaleLocked": "No"
    }
  }
}
 

立即购买命令

Support multi-thread

如果调用购买立即命令,则应包括以下参数:

购买请求参数
解释
domain您要购买的域名,每个请求只能输入一个1域名
currency (可选)返回结果的货币,如果没有输入货币,则应为"usd", "eur", 或 "cny",,默认将应用账户默认货币
XML结果标签
解释
<BuyItNowResponse></BuyItNowResponse>响应XML文件的根节点XML文件
<BuyItNowHeader></BuyItNowHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功,"0"为成功,"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息,仅状态为"error"时使用
<Message></Message>当状态为"成功"时,应为"域名订单已创建"。

立即购买示例

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=buy_it_now&domain=domain&currency=currency
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<BuyItNowResponse>
  <BuyItNowHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </BuyItNowHeader>
</BuyItNowResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=buy_it_now&domain=domain&currency=currency
Response (JSON format)
{
  "BuyItNowResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

设置 Afternic 确认动作命令

Support multi-thread

调用Set Afternic Confirm Action Command将设置域名在Afternic上快速转移的批准或不批准。此命令仅在XML和JSON格式中可用。如果调用此命令,则应包括以下参数:

设置Afternic确认动作请求参数
解释
domain您想设定的域名经Afternic确认快速转移操作,每个请求只能输入1个域名。
action您要对Afternic确认的操作,应为"confirm_afternic",或"delete_from_afternic"。
XML结果标签
解释
<SetAfternicConfirmActionResponse></SetAfternicConfirmActionResponse>设置Afternic确认操作响应的标签是响应的根节点 XML 文档。
<SetAfternicConfirmActionHeader></SetAfternicConfirmActionHeader>设置 Afternic 确认操作标头
<ResponseCode></ResponseCode>如果操作成功,则为成功的"0",失败的"-1"
<Status></Status>请求状态
<Error></Error>请求的错误信息仅在状态为“错误”时使用
Set Afternic Confirm Action Example
Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetAfternicConfirmActionResponse>
  <SetAfternicConfirmActionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetAfternicConfirmActionHeader>
</SetAfternicConfirmActionResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
Response (JSON format)
{
  "SetAfternicConfirmActionResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

设置 Sedo 确认动作命令

Support multi-thread

调用Set Sedo Confirm Action命令将在Sedo上设置域名以批准或不批准快速过户。此命令仅在XML和JSON格式中可用。如果调用此命令,则应包括以下参数:

设置 Sedo 确认操作请求参数
解释
domain您想要设置 Sedo 确认快速转移操作的域名,每次请求只能输入1个域名。
action您要设置Sedo确认的操作应为"confirm_sedo",或"delete_from_sedo"。
XML结果标签
解释
<SetSedoConfirmActionResponse></SetSedoConfirmActionResponse>Set Sedo确认操作响应的标记,是响应XML文档的根节点
<SetSedoConfirmActionHeader></SetSedoConfirmActionHeader>设置 Sedo 确认操作标题
<ResponseCode></ResponseCode>如果操作成功,则为成功的"0",失败的"-1"
<Status></Status>请求状态
<Error></Error>请求的错误信息仅在状态为“错误”时使用
Set Sedo Confirm Action Example
Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetSedoConfirmActionResponse>
  <SetSedoConfirmActionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetSedoConfirmActionHeader>
</SetSedoConfirmActionResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
Response (JSON format)
{
  "SetSedoConfirmActionResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

订单列表命令

Support multi-thread

调用命令列表命令将获取订单列表。此命令仅适用于XML和JSON格式。如果调用此命令,应包括以下参数。

订购列表请求参数
解释
search_by您可以从以下列表中选择一个值来表示您的搜索类型: date_range
domain
order_id
start_date您的查询开始日期的格式为yyyy/MM/dd
end_date您的查询的结束日期格式为yyyy/MM/dd
payment_method您可以从以下列表中选择多个值来表示您的付款方式: none_balance account_balance credit_card money_order paypal moneybookers bank_wire alipay payflow_credit_card2(已不再使用) wechat_pay ecash bank_transfer apple_pay checking_account sale union_pay paypal_account mercado_pago payoneer 但请使用逗号来分隔多个值,例如:account_balance,credit_card。
XML结果标签
解释
<OrderListResponse></OrderListResponse>响应的根节点
<OrderListHeader></OrderListHeader>订购清单标题
<ResponseCode></ResponseCode>如果操作成功,则为成功的"0",失败的"-1"
<Status></Status>请求状态
<Error></Error>请求的错误信息仅在状态为“错误”时使用
<OrderListContent></OrderListContent>订购清单标题
<OrderList></OrderList>包含多个订单日志数据集
<OrderItem></OrderItem>包含单个订单日志数据
<OrderItemDomain></OrderItemDomain>包含按照此顺序的域名
<OrderId></OrderId>包含订单的ID
<SubmittedDate></SubmittedDate>包含订单提交的日期
<Cost></Cost>包含订单的成本
<Status></Status>包含订单状态
Order List Example
Request (XML format) https://api.dynadot.com/api3.xml?key=0&searchBy=date_range&startDate=2024/01/01&endDate=2024/01/31&paymentMethod=account_balance,credit_card
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<OrderListResponse>
  <OrderListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </OrderListHeader>
  <OrderListContent>
    <OrderList>
      <Order>
        <OrderId>123456</OrderId>
        <SubmittedDate>1721588985531</SubmittedDate>
        <Currency>USD</Currency>
        <PaymentMethod>Account Balance</PaymentMethod>
        <TotalCost>$8.00</TotalCost>
        <TotalPaid>$8.00</TotalPaid>
        <Status>Problem</Status>
        <OrderItem>
          <ItemType>Domain Registration</ItemType>
          <Name>test.com</Name>
          <Duration>1</Duration>
          <Cost>2.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Renewal</ItemType>
          <Name>test1.ac</Name>
          <Duration>1</Duration>
          <Cost>3.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Transfer</ItemType>
          <Name>test2.de</Name>
          <Duration>1</Duration>
          <Cost>4.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Registration</ItemType>
          <Name>test3.gg</Name>
          <Duration>1</Duration>
          <Cost>5.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Renewal</ItemType>
          <Name>test4.uk</Name>
          <Duration>1</Duration>
          <Cost>6.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Transfer</ItemType>
          <Name>test5.net</Name>
          <Duration>1</Duration>
          <Cost>7.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
      </Order>
      <Order>
        <OrderId>123457</OrderId>
        <SubmittedDate>1721588985531</SubmittedDate>
        <Currency>EUR</Currency>
        <PaymentMethod>Paypal</PaymentMethod>
        <TotalCost>$100.00</TotalCost>
        <TotalPaid>$100.00</TotalPaid>
        <Status>Submitted</Status>
      </Order>
    </OrderList>
  </OrderListContent>
</OrderListResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=0&command=order_list&searchBy=date_range&startDate=2024/01/01&endDate=2024/01/31&paymentMethod=account_balance,credit_card
Response (JSON format)
{
  "OrderListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderList": [
      {
        "OrderId": "123456",
        "SubmittedDate": "2024/07/21",
        "Currency": "USD",
        "PaymentMethod": "Account Balance",
        "TotalCost": "$8.00",
        "TotalPaid": "$8.00",
        "Status": "Problem",
        "ItemList": [
          {
            "ItemType": "Domain Registration",
            "Name": "test.com",
            "Duration": 1,
            "Cost": "2.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Renewal",
            "Name": "test1.ac",
            "Duration": 1,
            "Cost": "3.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Transfer",
            "Name": "test2.de",
            "Duration": 1,
            "Cost": "4.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Registration",
            "Name": "test3.gg",
            "Duration": 1,
            "Cost": "5.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Renewal",
            "Name": "test4.uk",
            "Duration": 1,
            "Cost": "6.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Transfer",
            "Name": "test5.net",
            "Duration": 1,
            "Cost": "7.99",
            "Status": "Completed"
          }
        ]
      },
      {
        "OrderId": "123457",
        "SubmittedDate": "2024/07/21",
        "Currency": "EUR",
        "PaymentMethod": "Paypal",
        "TotalCost": "$100.00",
        "TotalPaid": "$100.00",
        "Status": "Submitted",
        "ItemList": []
      }
    ]
  }
}
 

获取订单状态命令

Support multi-thread

调用获取订单状态命令将获取订单状态。该命令仅适用于XML和JSON格式。如果调用此命令,则应包括以下参数:

获取订单状态请求参数
解释
order_id要查询的订单ID
XML结果标签
解释
<GetOrderStatusResponse></GetOrderStatusResponse>响应的根节点
<GetOrderStatusHeader></GetOrderStatusHeader>获取订单状态标题
<ResponseCode></ResponseCode>如果操作成功,则为成功的"0",失败的"-1"
<Status></Status>请求状态
<Error></Error>请求的错误信息仅在状态为“错误”时使用
<GetOrderStatusContent></GetOrderStatusContent>响应内容
<OrderId></OrderId>订单编号
<OrderStatus></OrderStatus>订单状态(购物中,已提交,等待付款,处理中,已完成,问题,已删除,已取消)
<ItemTypeName></ItemTypeName>项目类型
<ItemName></ItemName>项目名称
<ItemStatus></ItemStatus>项目状态(已完成、已取消、问题)
Get Order Status Example
Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_order_status&order_id=0
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetOrderStatusResponse>
  <GetOrderStatusHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetOrderStatusHeader>
  <GetOrderStatusContent>
    <OrderId>0</OrderId>
    <OrderStatus>Completed</OrderStatus>
    <Item>
      <ItemTypeName>domain transfer away</ItemTypeName>
      <ItemName>&amp;</ItemName>
      <ItemStatus>transfer.com</ItemStatus>
    </Item>
    <Item>
      <ItemTypeName>domain</ItemTypeName>
      <ItemName>&amp;</ItemName>
      <ItemStatus>register.com</ItemStatus>
    </Item>
  </GetOrderStatusContent>
</GetOrderStatusResponse>
Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_order_status&order_id=0
Response (JSON format)
{
  "GetOrderStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderStatus": {
      "OrderId": 0,
      "OrderStatus": "Completed",
      "ItemList": [
        {
          "ItemTypeName": "domain transfer away",
          "ItemName": "transfer.com",
          "ItemStatus": "Completed"
        },
        {
          "ItemTypeName": "domain",
          "ItemName": "register.com",
          "ItemStatus": "Completed"
        }
      ]
    }
  }
}
 

Is Processing命令

Support multi-thread

呼叫is_processing可让您知晓提交一个新请求是否安全

Is_Processing请求参数
解释
不需额外参数
XML结果标签
解释
<Response></Response>is_processing响应标签
<ResponseHeader></ResponseHeader>is_processing标题标签
<ResponseMsg></ResponseMsg>is_processing响应信息标签,标签应显示为“yes”(系统中有正在处理的请求,您不应发送另一个请求)或“no”(您的账户中已没有处理中的请求,可以安全地提交新请求)
Is-Processing Example
Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=is_processing
Response (XML format)
<Response>
  <ResponseHeader>
    <ResponseCode>0</ResponseCode>
    <ResponseMsg>yes</ResponseMsg>
  </ResponseHeader>
</Response>
Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=is_processing
Response (JSON format)
{
   "Response":{
      "ResponseCode":"0",
      "ResponseMsg":"no"
   }
}
Request 领域行业相关的专业要求。https://api.dynadot.com/api3.html?key=[API Key]&command=is_processing
Response 领域行业相关的专业要求。
ok,yes
你确定要关闭聊天吗?聊天将关闭,并清除聊天记录。
继续退出
或者在聊天中停留。
请审核此聊天记录点击这个窗口
Chat Online
在线聊天0