域名

域名API 命令列表

我们的 API 是您进阶的 域名管理 与收购利器,效率为先。50 余条命令覆盖 Dynadot 平台的设置、管理、注册与竞拍,让您在任选 API 软件中轻松掌控账户和域名设置。我们的 域名API 面向所有账户开放,即刻启程吧!

开始使用我们的高级 域名API

旧版 API, 计划退役. 请改用我们的 RESTful API:

https://www.dynadot.com/domain/api-document

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

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

请求应通过 https (安全套接字) 发送以保证安全. 请求应包含以下两个参数,一个 'Key' 和一个 'Command'. 每个命令都可以点击以查看与其关联的参数.

根据您账户的消费等级,您将获得不同的线程数:

支出等级线程数速率限制
普通会员1 个线程60/分钟 (1/秒)
黄金会员5 个线程600/分钟 (10/秒)
超级批量35 个线程6000/分钟 (100/秒)

 
请求参数
说明
Key您的访问API的密钥, 可在您的Dynadot账户 控制面板 中的 '工具' -> 'API' 侧边栏菜单下找到.
Command
域名:
search, register, delete, renew, push, transfer, bulk_register, restore

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, suggestion_search, set_dnssec, get_dnssec, clear_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
联系人:
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
域名服务器:
get_ns, add_ns, register_ns, set_ns_ip, delete_ns, delete_ns_by_domain, server_list, get_dns
账户:
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
文件夹:
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
二级市场:
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, add_new_lead
其他:
set_afternic_confirm_action, set_sedo_confirm_action, get_whois_stats, order_list, set_for_sale, get_order_status, is_processing, transfer_out_domain_list, list_coupons, download_all_listings

XML 格式. 你收到的响应应包含以下字段中的 2 个或 3 个:

结果 XML 标签
说明
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
 

搜索指令

支持多线程
支持 API 沙盒

调用搜索命令时, 应包含以下参数:

搜索请求参数
说明
domain0 - domain99您正在查找的 域名, 普通账户每条命令可指定 1 个域名, 批量账户和超级批量账户最多可指定 100 个域名
language0 - language99 (optional)相应域名的语言标签, 仅适用于 IDN
show_price (optional)若想以账户货币显示价格, 请将其设为 "1". 如果域名可注册, 将显示其溢价详情和价格信息.
currency (optional)您可以自行指定币种, 此参数支持 "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>关于 域名 的语言信息

搜索示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
响应 (XML 格式)
<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 and domain is not premium</Price>
    </SearchHeader>
  </SearchResponse>
</Results>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
响应 (JSON格式)
{
   "SearchResponse":{
      "ResponseCode":"0",
      "SearchResults":[
         {
            "DomainName":"mydomain.com",
            "Available":"yes",
            "Price":"77.00 in USD"
         },
         {
            "DomainName":"mydomain.net",
            "Available":"yes",
            "Price":"44.00 in USD"
         }
      ]
   }
}
 

注册命令

支持多线程
支持 API 沙盒

调用注册命令会创建并处理一笔注册订单. 你的账户余额必须足够支付该订单. 调用注册命令时, 应包含以下参数:

注册请求参数
说明
domain您要注册的 域名,每次请求仅能注册 1 个域名
language (optional)设置备注指令
duration域名注册时长
registrant_contact (optional)你想用于该域名的注册人联系人
admin_contact (optional)您想在该域名上使用的管理员联系人
technical_contact (optional)您希望在域名上使用的技术联系人
billing_contact (optional)您想在该域名上使用的账单联系人
option0 (if necessary)
.AT, .BE, 注册人姓名
option1 (if necessary).AT, .BE, 注册人组织 (可选)
对于 .AT, 您可以指定 option0, option1, 或两者都指定
premium (optional)如果你想注册一个 精品域名,请将其设为 "1"(可选)。
currency (optional)您可以自行指定币种, 此参数支持 "USD","CNY", "GBP","EUR","INR","CAD" 等. 若漏掉此参数, 我们将采用账户的默认币种.
coupon (optional)您想应用到这条命令上的优惠码
结果 XML 标签
说明
<RegisterResponse></RegisterResponse>注册响应的标签
<RegisterHeader></RegisterHeader>注册页头的标签
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<RegisterContent></RegisterContent>注册内容的标签
<Expiration></Expiration>过期时间 的日期,以 Unix 时间表示(即自 1970 年 1 月 1 日 UTC 午夜起算的毫秒数),仅当结果为 "success" 时才会用到
<Registration></Registration>注册日期,采用 Unix 时间(自 1970 年 1 月 1 日 UTC 午夜起算的毫秒数),仅在结果为 "success" 时使用。

注册示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=register&domain=domain1.net&duration=3&currency=USD
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=register&domain=domain1.net&duration=3&currency=USD
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<RegisterResponse>
  <RegisterHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterHeader>
  <RegisterContent>
    <Expiration>1458379145266</Expiration>
  </RegisterContent>
</RegisterResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=register&domain=domain1.net&duration=3&currency=USD
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=register&domain=domain1.net&duration=3&currency=USD
响应 (JSON格式)
{
  "RegisterResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainName": "domain1.net",
    "Expiration": 1458379145266
  }
}
 

删除命令

支持多线程
支持 API 沙盒

调用 delete 命令会删除仍处于 宽限期 中的域名。注册费将退回至您的账户余额。已续费或已转移到新账户的域名,无法通过 API 删除。调用 delete 命令时,应包含以下参数:

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

删除示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete&domain=domain1.com
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete&domain=domain1.com
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteResponse>
  <DeleteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteHeader>
</DeleteResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=delete&domain=domain1.com
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete&domain=domain1.com
响应 (JSON格式)
{
  "DeleteResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainName": "domain1.com"
  }
}
 

续费命令

支持多线程
支持 API 沙盒

调用续费命令将创建并处理续费订单. 您必须拥有足够的账户余额来支付该订单. 如果调用续费命令, 应包含以下参数:

续费请求参数
说明
domain您要续费的 域名,每次请求仅能续费 1 个域名
duration域名续费年数
year (optional)域名当前到期的年份
currency (optional)您可以自行指定币种, 此参数支持 "USD","CNY", "GBP","EUR","INR","CAD" 等. 若漏掉此参数, 我们将采用账户的默认币种.
price_check (optional)您可以将此参数添加到命令中,以查看续费此域名的价格详情。注意:将此参数添加到命令后,我们的 API 不会续费域名,而只会显示价格信息。
coupon (optional)您想应用到这条命令上的优惠码
no_renew_if_late_renew_fee_needed (optional)如果域名需要支付逾期续费费用, 您可以将此参数添加到命令中以避免续费. 如果域名确实需要支付逾期续费费用才能续费, 且命令中传入了 "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 日 UTC 午夜起算的毫秒数),仅当结果为 "success" 时才会用到

续费示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
响应 (XML 格式)
<RenewResponse>
  <RenewHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RenewHeader>
  <RenewContent>
    <Expiration>73984579834</Expiration>
  </RenewContent>
</RenewResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
响应 (JSON格式)
{
   "RenewResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domain1.com",
      "Expiration":"73984579834"
   }
}
 

推送命令

支持多线程
支持 API 沙盒

调用 push 命令会创建并处理一条推送订单。您必须为该订单解锁域名和账户。接收方账户需拒绝/接受域名,订单方可完成。若调用 push 命令,应包含以下参数:

推送请求参数
说明
domain您想推送的 域名. 批量推送也支持, 用 ";" 把域名分开就行. 示例: domain1.com;domain2.com
receiver_push_username接收方账户的 Push 用户名
currency (optional)您可以自行指定币种, 此参数支持 "USD","CNY", "GBP","EUR","INR","CAD" 等. 若漏掉此参数, 我们将采用账户的默认币种.
unlock_domain_for_push(optional)将此参数设为 "1"。若域名处于锁定状态,我们将自动为您解锁,因此无需手动解锁域名。
receiver_email(optional)推送接收方账户的 电子邮件
结果 XML 标签
说明
<PushResponse></PushResponse>推送响应的标签,它是响应 XML 文档的根节点
<PushHeader></PushHeader>推送标头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

推送示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
响应 (XML 格式)
<PushResponse>
  <PushHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
  </PushHeader>
</PushResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
响应 (JSON格式)
{
   "PushResponse":{
      "ResponseCode":"0",
      "Status":"order created"
   }
}
 

转移指令

支持多线程
支持 API 沙盒

调用转移命令将创建并处理转移订单。部分 TLDs 可能需要转出注册商确认,才能完成订单。若调用转移命令,则需包含以下参数:

转移请求参数
说明
domain您希望转入 Dynadot 的 域名,每次请求仅限转移 1 个域名
auth用于转移请求的 授权码.
currency (optional)您可以自行指定币种, 此参数支持 "USD","CNY", "GBP","EUR","INR","CAD" 等. 若漏掉此参数, 我们将采用账户的默认币种.
registrant_contact (optional)转移完成时您想使用的注册人联系人. (并非所有 TLD 都支持此功能)
admin_contact (optional)转移完成后您想使用的管理员联系人. (并非所有 TLD 都支持此功能)
technical_contact (optional)转移完成后希望使用的技术联系人。(并非所有 TLD 都支持此功能)
billing_contact (optional)转移完成后您希望使用的账单联系人。(并非所有 TLD 都支持此功能)
premium (optional)如果你想转移一个 精品域名,请将其设为 "1" (可选)。
privacy (optional)您要设置的域名隐私状态,可以是 "on" 或 "off"。若输入有误或未提供,将使用账户默认的 域名隐私级别。
name_servers (optional)转移完成后,将 域名服务器 列表应用到该域名。你可以用 "," 来分隔 域名服务器。例如:ns1.domain1.com,ns2.domain2.com
coupon (optional)您想应用到这条命令上的优惠码
结果 XML 标签
说明
<TransferResponse></TransferResponse>转移响应的标签,即响应 XML 文档的根节点
<TransferHeader></TransferHeader>转移标头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

转移示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<TransferResponse>
  <TransferHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
    <DomainName>domain1.com</DomainName>
    <OrderId>1234567</OrderId>
  </TransferHeader>
</TransferResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
响应 (JSON格式)
{
  "TransferResponse": {
    "ResponseCode": 0,
    "Status": "order created",
    "DomainName": "domain1.com",
    "OrderId": "1234567"
  }
}
 

批量注册命令

支持多线程
支持 API 沙盒

调用批量注册命令会创建并处理注册订单,账户余额得够付这些订单。调用批量注册命令时,应包含以下参数:

批量注册请求参数
说明
domain0-domain99您想要注册的 域名(s),每次请求最多可注册 100 个域名
premium (optional)如果你想注册一个 精品域名,请将其设为 "1"(可选)。
currency (optional)您可以自行选择货币类型,该参数支持 "USD"、"CNY"、"GBP"、"EUR"、"INR"、"CAD" 等。若您遗漏此参数,我们将默认使用账户的默认货币。
coupon (optional)您想应用到这条命令上的优惠码
结果 XML 标签
说明
<BulkRegisterResponse></BulkRegisterResponse>批量注册响应的标签
<BulkRegisterHeader></BulkRegisterHeader>批量注册头部的标签
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<BulkRegisterContent></BulkRegisterContent>批量注册内容的标签
<Expiration></Expiration>过期时间 的日期,以 Unix 时间表示(即自 1970 年 1 月 1 日 UTC 午夜起算的毫秒数),仅当结果为 "success" 时才会用到
<Result></Result>注册操作的结果
<Message></Message>注册操作的错误信息,仅在 result 为 "error" 时使用。

批量注册示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
响应 (JSON格式)
{
  "BulkRegisterResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BulkRegister": [
      {
        "DomainName": "domain0.com",
        "Expiration": "1234567890",
        "Result": "success",
        "Message": "-"
      },
      {
        "DomainName": "domain1.com",
        "Expiration": "-",
        "Result": "error",
        "Message": "not_available"
      }
    ]
  }
}
 

域名信息命令

支持多线程
支持 API 沙盒

此命令仅支持 XML 和 JSON 格式:

域名信息请求参数
说明
domain每次请求仅允许 1 个域名
结果 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 日 UTC 午夜起的毫秒数)
<Registration></Registration>域名注册 的日期,采用 Unix 时间 (自 1970 年 1 月 1 日 UTC 午夜起算的毫秒数)
<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>文件夹名称

域名信息示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=domain_info&domain=domain1.com
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=domain_info&domain=domain1.com
响应 (XML 格式)
<?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>
      <Status>active</Status>
    </Domain>
  </DomainInfoContent>
</DomainInfoResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=domain_info&domain=domain1.com
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=domain_info&domain=domain1.com
响应 (JSON格式)
{
  "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)"
      },
      "Status": "active"
    }
  }
}
 

设置 Whois 命令

支持多线程
支持 API 沙盒

若调用 set 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" 时使用。

设置 Whois 示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
响应 (XML 格式)
<SetWhoisResponse>
  <SetWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetWhoisHeader>
</SetWhoisResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
响应 (JSON格式)
{
   "SetWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置 域名服务器 命令

支持多线程
支持 API 沙盒

调用 set 域名服务器 命令时, 应包含以下参数:

设置 域名服务器 的请求参数
说明
domain您要设置的 域名,每次请求最多可设置 100 个域名,请确保以逗号分隔
ns0 - ns12为你的域名设置要使用的 域名服务器, 你最多可指定 13 个 域名服务器, 但它们必须已经存在于你的账户中
结果 XML 标签
说明
<SetNsResponse></SetNsResponse>设置名称服务器响应的标签,它是响应 XML 文档的根节点
<SetNsHeader></SetNsHeader>设置名称服务器响应头的标签
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置 NS 示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<SetNsResponse>
  <SetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsHeader>
</SetNsResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
响应 (JSON格式)
{
  "SetNsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

设置 域名停靠 命令

支持多线程
支持 API 沙盒

若调用 set 域名停靠 命令,则需一并提供以下参数:

设置 域名停靠 请求参数
说明
domain您要设置的 域名,每次请求最多可设置 100 个域名,请确保以逗号分隔
with_ads (optional)若你不想展示第三方广告,可将此参数设为 "no"
结果 XML 标签
说明
<SetParkingResponse></SetParkingResponse>设置 域名停靠 响应的标签, 它是响应 XML 文档的根节点
<SetParkingHeader></SetParkingHeader>设置 域名停靠 文件夹标头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置 域名停靠 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_parking&domain=domain1.com&with_ads=no
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_parking&domain=domain1.com&with_ads=no
响应 (XML 格式)
<SetParkingResponse>
  <SetParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetParkingHeader>
</SetParkingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_parking&domain=domain1.com&with_ads=no
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_parking&domain=domain1.com&with_ads=no
响应 (JSON格式)
{
   "SetParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置转发命令

支持多线程
支持 API 沙盒

调用设置转发命令时, 应包含以下参数:

设置转发请求参数
说明
domain您要设置的 域名,每次请求最多可设置 100 个域名,请确保以逗号分隔
forward_url你希望域名转发到的 URL。请注意,该参数必须为 已编码 以便 API 调用能被正确解析.
is_temp (optional)您所需的域名转发状态,默认值为 "temporary";如需永久转发,请将此参数设为 "no"
结果 XML 标签
说明
<SetForwardingResponse></SetForwardingResponse>响应 XML 文档的根节点
<SetForwardingHeader></SetForwardingHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置转发示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
响应 (XML 格式)
<SetForwardingResponse>
  <SetForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetForwardingHeader>
</SetForwardingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
响应 (JSON格式)
{
   "SetForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置隐身命令

支持多线程
支持 API 沙盒

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

设置隐身请求参数
说明
domain您要设置的 域名,每次请求最多可设置 100 个域名,请确保以逗号分隔
stealth_url你希望域名转发到的 URL。请注意,该参数必须为 已编码 以便 API 调用能被正确解析.
stealth_title (optional)页面标题
结果 XML 标签
说明
<SetStealthResponse></SetStealthResponse>响应 XML 文档的根节点
<SetStealthHeader></SetStealthHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置 Stealth 示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
响应 (XML 格式)
<SetStealthResponse>
  <SetStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetStealthHeader>
</SetStealthResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
响应 (JSON格式)
{
   "SetStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置托管命令

支持多线程
支持 API 沙盒

若调用设置托管命令,应包含以下参数:

设置主机请求参数
说明
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" 时使用。

设置托管示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
响应 (XML 格式)
<SetHostingResponse>
  <SetHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetHostingHeader>
</SetHostingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
响应 (JSON格式)
{
   "SetHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置 DNS2 命令

支持多线程
支持 API 沙盒

调用 set DNS2 命令时,应包含以下参数:

请注意,执行 SET_DNS2 命令时,默认会覆盖当前的 DNS设置。如果想改变这种行为,改为追加新的 DNS设置,可以使用可选参数 add_dns_to_current_setting。

设置 DNS2 请求参数
说明
domain您要设置的 域名,每次请求最多可设置 100 个域名,请确保以逗号分隔
main_record_type0 - main_record_type19 (optional)主记录类型,应为 "a"、"aaaa"、"cname"、"forward"、"txt"、"mx"、"stealth"、"电子邮件"
main_record0 - main_record19为您的域名指定 DNS 记录
main_recordx0 - main_recordx19Mx 距离、转发类型(301 记为 "1",302 记为 "2")、隐形转发标题或 电子邮件 别名,在 main_record_type 为 "forward"、"mx"、"stealth"、"电子邮件" 时为必填项。
subdomain0 - subdomain99 (optional)子域名 记录(可选)
sub_record_type0 - sub_record_type99子域名 记录类型,应为 "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "电子邮件"
sub_record0 - sub_record99子域名 IP 地址或目标主机
sub_recordx0 - sub_recordx99MX 距离、转发类型、隐形转发标题或 电子邮件 别名;当 main_record_type 为 "forward"、"mx"、"stealth"、"电子邮件" 时必填
ttl (optional)生存时间
add_dns_to_current_setting (optional)若要将新的 DNS设置 追加到现有的 DNS设置 之后,请将其设为 "1"(可选)
结果 XML 标签
说明
<SetDnsResponse></SetDnsResponse>响应 XML 文档的根节点
<SetDnsHeader></SetDnsHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置 DNS2 示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox 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
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnsResponse>
  <SetDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnsHeader>
</SetDnsResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox 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
响应 (JSON格式)
{
  "SetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

设置 DNSSEC 命令

支持多线程
支持 API 沙盒

调用设置 DNSSEC 命令将为域名 DNSSEC 进行设置。此命令仅支持 XML 和 JSON 格式。若调用此命令,则应包含以下参数:

您可以根据自己的 域名 选择在 Option 中填写对应的参数值.

选项 1 : domain_name , key_tag , digest_type , digest , algorithm

选项 2 : domain_name , flags , public_key , algorithm

注意: 如有需要,请选择对应标签的编号作为您的参数值.

设置 DNSSEC 请求参数
说明
domain_name您需要为其设置 DNSSEC 的 域名
key_tag密钥标签
digest_type你可以从以下列表中选择一个数字来代表你的数字签名类型: SHA-1(1) SHA-256(2) GOSTR 34.11-94 (3) SHA-384(4)
digest请输入您所选摘要类型对应的值
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 曲线 P-256 搭配 SHA-256(13 ECDSA 曲线 P-384 搭配 SHA-384(14) ED25519(15 ED448(16) 间接 (252) 私有 DNS (253 私有 OID (254)
flags你可从下列列表中选一个数字,作为你的数字签名符号:ZSK(256) KSK(257)
public_key公钥必须采用 base64 编码。
结果 XML 标签
说明
<SetDnssecResponse></SetDnssecResponse>响应的根节点
<SetDnssecHeader></SetDnssecHeader>设置 DNSSEC 标头
<ResponseCode></ResponseCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置 DNSSEC 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnssecResponse>
  <SetDnssecHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnssecHeader>
  <SetDnssecContent/>
</SetDnssecResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
响应 (JSON格式)
{
  "SetDnssecResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

清除 DNSSEC 命令

支持多线程
支持 API 沙盒

调用 Clear DNSSEC 命令将清除域名 DNSSEC. 该命令仅支持 XML 和 JSON 格式.调用此命令时,应包含以下参数:

清除 DNSSEC 请求参数
说明
domain_name需要清除 DNSSEC 的 域名

清除 DNSSEC 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=clear_dnssec&domain_name=domain-haha1.com
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=clear_dnssec&domain_name=domain-haha1.com
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<ClearDnssecResponse>
  <ClearDnssecHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ClearDnssecHeader>
</ClearDnssecResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=clear_dnssec&domain_name=domain-haha1.com
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=clear_dnssec&domain_name=domain-haha1.com
响应 (JSON格式)
{
  "ClearDnssecResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

设置 电子邮件 转发命令

支持多线程
支持 API 沙盒

如果调用 set 电子邮件 forward 命令, 应包含以下参数:

设置 电子邮件 转发请求参数
说明
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" 时使用。

设置 电子邮件 转发示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
响应 (XML 格式)
<SetEmailForwardingResponse>
  <SetEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetEmailForwardingHeader>
</SetEmailForwardingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
响应 (JSON格式)
{
   "SetEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置清除域名设置命令

支持多线程
支持 API 沙盒

如果调用 set clear domain setting 命令, 则应包含以下参数:

设置清除域名配置请求参数
说明
domain您要设置的 域名,每次请求最多可设置 100 个域名,请确保以逗号分隔
service您要清除的服务,可选值为 "forward"、"stealth"、"email_forwarding"、"dns"、"DNSSEC" 以及 "nameservers"。
结果 XML 标签
说明
<SetClearDomainSettingResponse></SetClearDomainSettingResponse>响应 XML 文档的根节点
<SetClearDomainSettingHeader></SetClearDomainSettingHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置清除域名设置的示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
响应 (XML 格式)
<SetClearDomainSettingResponse>
  <SetClearDomainSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDomainSettingHeader>
</SetClearDomainSettingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
响应 (JSON格式)
{
   "SetClearDomainSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹命令

支持多线程
支持 API 沙盒

若要调用设置文件夹命令,应包含以下参数:

设置文件夹请求参数
说明
domain要更新的 域名,每次请求只能设置 1 个域名
folder您希望将域名移入的文件夹名称。若要将域名移至默认文件夹,请以 "Default" 作为文件夹名。文件夹名区分大小写。例如,"Folder1" 与 "folder1" 就是两个不同的文件夹名称。
folder_id (optional)您想将域名移至的目标文件夹 ID
结果 XML 标签
说明
<SetFolderResponse></SetFolderResponse>用于设置文件夹响应的标签, 它是响应 XML 文档的根节点
<SetFolderHeader></SetFolderHeader>设置文件夹标头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置文件夹示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder&domain=domian1.com&folder=folder1
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder&domain=domian1.com&folder=folder1
响应 (XML 格式)
<SetFolderResponse>
  <SetFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHeader>
</SetFolderResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder&domain=domian1.com&folder=folder1
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder&domain=domian1.com&folder=folder1
响应 (JSON格式)
{
   "SetFolderResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置备注命令

支持多线程
支持 API 沙盒

如果调用 set note 命令,应包含以下参数:

设置备注请求参数
说明
domain您想设置的域名, 每次请求只能设置 1 个域名
note您想设置到该域名的备注, 可以为 null
结果 XML 标签
说明
<SetNoteResponse></SetNoteResponse>响应 XML 文档的根节点
<SetNoteHeader></SetNoteHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置备注示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
响应 (XML 格式)
<SetNoteResponse>
  <SetNoteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNoteHeader>
</SetNoteResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
响应 (JSON格式)
{
   "SetNoteResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置 续费选项

支持多线程
支持 API 沙盒

如果调用 set 续费选项 命令, 应包含以下参数:

设置 续费选项 请求参数
说明
domain您要设置的 域名,每次请求最多可设置 100 个域名,请确保以逗号分隔
renew_option它可以是 "donot", "auto", "reset"
结果 XML 标签
说明
<SetRenewOptionResponse></SetRenewOptionResponse>响应 XML 文档的根节点
<SetRenewOptionHeader></SetRenewOptionHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置 续费选项 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<SetRenewOptionResponse>
  <SetRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetRenewOptionHeader>
</SetRenewOptionResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
响应 (JSON格式)
{
  "SetRenewOptionResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

设置隐私保护命令

支持多线程
支持 API 沙盒

若要调用设置隐私命令, 请记得包含以下参数:

设置隐私请求参数
说明
domain您要设置的 域名,每次请求最多可设置 100 个域名,请确保以逗号分隔
option想给域名设置的隐私状态, 可以是 "full", "partial" 或 "off"
whois_privacy_option您想设置的域名 Whois域名隐私保护 状态,可以是 "yes" 或 "no"
结果 XML 标签
说明
<SetPrivacyResponse></SetPrivacyResponse>响应 XML 文档的根节点
<SetPrivacyHeader></SetPrivacyHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置隐私示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
响应 (XML 格式)
<SetPrivacyResponse>
  <SetPrivacyHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetPrivacyHeader>
</SetPrivacyResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
响应 (JSON格式)
{
   "SetPrivacyResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

顶级域名价格

支持多线程
支持 API 沙盒

此功能仅支持 XML 和 JSON 格式:

顶级域名价格 请求参数
说明
currency (optional)返回结果的货币单位, 它应为 "usd", "eur", 或 "cny", 默认货币为账户设置中的 Api Default Currency
count_per_page (optional)每页显示多少个实体
page_index (optional)您想查看哪一页的实体
sort (optional)请从以下选项中选择一项,作为排序参数的值:
* 如果你尚未选择, 我们将使用默认排序.
1) 排名升序 (默认)
2) 排名描述
3) 按名称升序
4) 名称降序
5) 销售额升序
6) 销售描述
7) 上线日期升序
8) 上线日期说明
9) 计数升序
10) 数量降序
11) 注册局升序
12) 注册局描述
结果 XML 标签
说明
<TldPriceResponse></TldPriceResponse>响应 XML 文档的根节点
<TldPriceResponseHeader></TldPriceResponseHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<TldPriceContent></TldPriceContent>响应内容
<TldContent></TldContent>顶级域名信息
<Tld></Tld>顶级域名
<Usage></Usage>TLD 的用法
<Price></Price>此顶级域的价格信息。包含以下子标签: : 价格单位 : 注册价格 : 续费价格 : 转移价格
<Privacy></Privacy>如果该 TLD 支持 Whois域名隐私保护
<GracePeriod></GracePeriod>宽限期 此顶级域的信息. 包含子标签: : 宽限期 信息的单位 : 续费 宽限期 : 删除 宽限期
<IDN></IDN>如果此 tld 支持 国际化域名
<Restrictions></Restrictions>域名

顶级域名价格 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=tld_price&currency=USD
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=tld_price&currency=USD
响应 (XML 格式)
<?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>General</Usage>
      <Price>
        <Unit>(Price/1 year)</Unit>
        <Register>15.00</Register>
        <Renew>15.00</Renew>
        <Transfer>15.00</Transfer>
        <Restore>10.00</Restore>
      </Price>
      <Privacy>10.00</Privacy>
      <GracePeriod>
        <Unit>10.00</Unit>
        <Renew>10.00</Renew>
        <Delete>30</Delete>
        <Restore>YES</Restore>
      </GracePeriod>
      <IDN>YES</IDN>
      <Restrictions>--</Restrictions>
      <OnSale>Yes</OnSale>
      <maxDuration>10</maxDuration>
      <minDuration>1</minDuration>
    </TldContent>
  </TldPriceContent>
</TldPriceResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=tld_price&currency=USD
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=tld_price&currency=USD
响应 (JSON格式)
{
  "TldPriceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "PriceLevel": "Regular Pricing",
    "Currency": "USD",
    "TldPrice": [
      {
        "Tld": "com",
        "Usage": "General",
        "IDN": "YES",
        "Restrictions": "--",
        "OnSale": "Yes",
        "Privacy": "10.00",
        "Price": {
          "Unit": "(Price/1 year)",
          "Register": "15.00",
          "Renew": "15.00",
          "Transfer": "15.00",
          "Restore": "10.00"
        },
        "GracePeriod": {
          "Unit": "10.00",
          "Renew": "10.00",
          "Delete": "30",
          "Restore": "YES"
        },
        "maxDuration": 10,
        "minDuration": 1
      }
    ]
  }
}
 

列出域名命令

支持多线程
支持 API 沙盒

此功能仅支持 XML 和 JSON 格式:

列出域名请求参数
说明
customer_id (optional)按客户 ID 筛选数据 (仅 代理商 可使用此参数)
count_per_page (optional)每页显示多少个实体
page_index (optional)您想查看哪一页的实体
sort (optional)请从以下选项中选择一项,作为排序参数的值:
* 如果你尚未选择, 我们将使用默认排序.
1) 数量升序 (默认)
2) 数量降序
3) 按名称升序
4) 名称降序
结果 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 日 UTC 午夜起的毫秒数)
<Registration></Registration>域名注册 的日期,采用 Unix 时间 (自 1970 年 1 月 1 日 UTC 午夜起算的毫秒数)
<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>文件夹名称

列出域名示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=list_domain
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=list_domain
响应 (XML 格式)
<?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>
          <Status>active</Status>
        </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>
          <Status>moved</Status>
        </Domain>
      </DomainInfo>
    </DomainInfoList>
  </ListDomainInfoContent>
</ListDomainInfoResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=list_domain
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=list_domain
响应 (JSON格式)
{
  "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)"
        },
        "Status": "active"
      },
      {
        "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)"
        },
        "Status": "moved"
      }
    ]
  }
}
 

锁定域名命令

支持多线程
支持 API 沙盒

调用锁定域名命令时,应包含以下参数:

锁定域名请求参数
说明
domain您想要锁定的 域名,每次请求仅能输入 1 个域名
结果 XML 标签
说明
<LockDomainResponse></LockDomainResponse>响应 XML 文档的根节点XML 文档
<LockDomainHeader></LockDomainHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

锁定域名示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=lock_domain&domain=domain4.com
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=lock_domain&domain=domain4.com
响应 (XML 格式)
<LockDomainResponse>
   <LockDomainHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </LockDomainHeader>
</LockDomainResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=lock_domain&domain=domain4.com
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=lock_domain&domain=domain4.com
响应 (JSON格式)
{
   "LockDomainResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

建议搜索命令

支持多线程
支持 API 沙盒

调用建议搜索命令将购买指定的 域名. 该命令仅支持 XML 和 JSON 格式. 调用该命令时, 应包含以下参数:

建议搜索请求参数
说明
domain您要搜索的域名, 每次请求仅限输入 1 个域名
tlds (optional)搜索结果中仅包含的 TLDs
结果 XML 标签
说明
<SuggestionSearchResponse></SuggestionSearchResponse>建议搜索响应的标签, 它是响应 XML 文档的根节点
<SuggestionSearchHeader></SuggestionSearchHeader>建议搜索标头
<ResponseCode></ResponseCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

建议搜索示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
沙盒请求 (XML 格式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<SuggestionSearchResponse>
  <SuggestionSearchHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SuggestionSearchHeader>
  <SuggestionSearchContent>
    <SuggestionSearch>
      <Domain>test1.com</Domain>
      <Domain>test2.com</Domain>
      <Domain>test3.net</Domain>
      <Domain>test4.net</Domain>
    </SuggestionSearch>
  </SuggestionSearchContent>
</SuggestionSearchResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
沙盒请求 (JSON格式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
响应 (JSON格式)
{
  "SuggestionSearchResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Domains": [
      "test1.com",
      "test2.com",
      "test3.net",
      "test4.net"
    ]
  }
}
 

取消转移命令

支持多线程
支持 API 沙盒

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

取消转移请求参数
说明
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" 时使用。

取消转移示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=cancel_transfer&domain=domain4.com
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=cancel_transfer&domain=domain4.com
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<CancelTransferResponse>
  <CancelTransferHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CancelTransferHeader>
</CancelTransferResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=cancel_transfer&domain=domain4.com
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=cancel_transfer&domain=domain4.com
响应 (JSON格式)
{
  "CancelTransferResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

获取转移状态命令

支持多线程
支持 API 沙盒

如果调用 get transfer status 命令,应包含以下参数:

获取转移状态请求参数
说明
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>订单编号
<TransferStatus></TransferStatus>域名的转移状态.若状态为 'none' 或 'approved', 您可以取消转移.若状态为 'waiting', 表示转移已开始.若状态为 'auth code needed', 表示授权码有误, 您可以使用另一个 api SET_TRANSFER_AUTH 重新提交授权码.此外还有一些其他状态, 我们会向您发送 电子邮件, 或需由我们的工程师进行检查.

获取转移状态示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
响应 (JSON格式)
{
  "GetTransferStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "TransferList": [
      {
        "OrderId": "testorderid",
        "TransferStatus": "teststatus"
      },
      {
        "OrderId": "testorderid2",
        "TransferStatus": "teststatus2"
      }
    ]
  }
}
 

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

支持多线程
支持 API 沙盒

该命令允许您更新授权码,以处理转移订单。如果调用 set transfer auth code 命令,应包含以下参数:

设置转移授权码的请求参数
说明
domain你要更新转移授权的 域名,每次请求只能填写 1 个域名
auth_code您想要重新提交的 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" 时使用。

设置转移授权码示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
响应 (XML 格式)
<SetTransferAuthCodeResponse>
   <SetTransferAuthCodeHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetTransferAuthCodeHeader>
</SetTransferAuthCodeResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
响应 (JSON格式)
{
   "SetTransferAuthCodeResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

授权转出命令

支持多线程
支持 API 沙盒
授权转出请求参数
说明
domain你想授权转出的 域名,每次请求只能输入 1 个域名。
order_id你想要转出的域名对应的 Dynadot order_id
authorize若要授权转出,请将其设为 "approve";若要拒绝转出,请将其设为 "deny"。
结果 XML 标签
说明
<AuthorizeTransferAwayResponse></AuthorizeTransferAwayResponse>响应 XML 文档的根节点XML 文档
<AuthorizeTransferAwayHeader></AuthorizeTransferAwayHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<Result></Result>授权转出的结果

授权转出示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<AuthorizeTransferAwayResponse>
  <AuthorizeTransferAwayHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <Result>away_approved</Result>
  </AuthorizeTransferAwayHeader>
</AuthorizeTransferAwayResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
响应 (JSON格式)
{
  "AuthorizeTransferAwayResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Result": "away_approved"
  }
}
 

获取转移授权码命令

支持多线程
支持 API 沙盒

申请授权码之前,您必须先解锁域名和账户。

获取转移授权码的请求参数
说明
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>授权码用于启动域名转移。

获取转移授权码示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<GetTransferAuthCodeResponse>
  <GetTransferAuthCodeHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <AuthCode>testauthcode</AuthCode>
  </GetTransferAuthCodeHeader>
</GetTransferAuthCodeResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
响应 (JSON格式)
{
  "GetTransferAuthCodeResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AuthCode": "testauthcode"
  }
}
 

获取域名推送请求命令

支持多线程
支持 API 沙盒

调用 Get Domain Push Request 命令,即可获取域名推送请求。此命令仅支持 XML 和 JSON 格式。

获取域名推送请求的请求参数
说明
N/A 无需额外参数
结果 XML 标签
说明
<GetDomainPushRequestResponse></GetDomainPushRequestResponse>响应的根节点
<GetDomainPushRequestHeader></GetDomainPushRequestHeader>获取域名推送请求头
<ResponseCode></ResponseCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<GetDomainPushRequestContent></GetDomainPushRequestContent>响应内容
<PushDomain></PushDomain>推送域名
<PushDomainName></PushDomainName>推送 域名

获取域名推送请求示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_domain_push_request
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_domain_push_request
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_domain_push_request
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_domain_push_request
响应 (JSON格式)
{
  "GetDomainPushRequestResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "pushDomainName": "[haha.com,haha1.com]"
  }
}
 

设置域名推送请求命令

支持多线程
支持 API 沙盒

调用设置域名推送请求命令将设置域名推送请求. 此命令仅支持 XML 和 JSON 格式.如果调用此命令, 应包含以下参数:

设置域名推送请求的请求参数
说明
domains待处理订单的 域名
action待处理订单的操作,你可以选择 "accept" 或 "decline"
结果 XML 标签
说明
<SetDomainPushRequestResponse></SetDomainPushRequestResponse>响应的根节点
<SetDomainPushRequestHeader></SetDomainPushRequestHeader>设置域名推送请求头
<ResponseCode></ResponseCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置域名推送请求示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<SetDomainPushRequestResponse>
  <SetDomainPushRequestHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetDomainPushRequestHeader>
  <SetDomainPushRequestContent/>
</SetDomainPushRequestResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept
响应 (JSON格式)
{
  "SetDomainPushRequestResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

创建 CN 审核命令

支持多线程
支持 API 沙盒

该命令允许你为联系人创建 CN 审核。如果调用 create cn audit 命令,应包含以下参数:

创建 CN 审核请求参数
说明
contact_id您要开始审核的联系人记录 ID, 每个请求只能输入 1 个联系人 ID
contact_type联系人类型,可以是 "Individual" 或 "Enterprise"
individual_id_type自然人证件类型,预期值(值的说明)如下:
JGZ (中华人民共和国军官证)
SFZ(中华人民共和国身份证)
HZ (护照)
GAJMTX (往来港澳通行证)
TWJMTX (台湾居民来往大陆通行证)
WJLSFZ(中华人民共和国外国人永久居留身份证)
GAJZZ (港澳居民居住证)
TWJZZ (台湾居民居住证)
QT (其他)
individual_license_id自然人身份证件的证件号码
individual_url自然人证件 ID 的文档。服务器上的文件 URL。仅允许 jpg、gif、png、jpeg
enterprise_id_type (Mandatory when contact type is "Enterprise")企业 ID 类型, 预期值 (值的描述) 为:
ORG(组织机构代码证书)
YYZZ (营业执照)
TYDM (统一社会信用代码证书)
BDDM (军事代码标识)
JDDWFW (军队对外有偿服务许可证)
SYDWFR (事业单位法人证书)
WGCZJG(外国企业常驻代表机构登记表)
SHTTFR(社会组织法人登记证书)
ZJCS(宗教活动场所登记证)
MBFQY(民办非企业单位登记证书)
JJHFR (基金法人登记证书)
LSZY (律师事务所执业许可证)
WGZHWH(外国文化中心在华登记证书)
WLCZJG (外国政府旅游部门常驻代表机构批准登记证)
SFJD (司法鉴定许可证)
JWJG (境外机构证书)
SHFWJG (社会服务机构登记证书)
MBXXBX (私立学校许可证)
YLJGZY(医疗机构执业许可证)
GZJGZY (公证机构执业许可证)
BJWSXX (北京市外国驻华使馆人员子女学校许可)
QTTYDM (其他-统一社会信用代码证书)
QT (其他)
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 审核示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox 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
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<CreateCnAuditResponse>
  <CreateCnAuditHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateCnAuditHeader>
</CreateCnAuditResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox 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
响应 (JSON格式)
{
  "CreateCnAuditResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

获取 CN 审核状态命令

支持多线程
支持 API 沙盒

如果调用 get cn audit status 命令,应包含以下参数:

获取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 审核记录的审核状态. 您可能会看到 'processing' 或 'waiting for cnnic' 或 'failed'. 如果失败, 我们会向您发送 电子邮件.
<FailedReason></FailedReason>如果审核未通过, 失败原因将会显示

获取 Cn 审核状态示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_cn_audit_status&contact_id=testcontactid
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_cn_audit_status&contact_id=testcontactid
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<GetCnAuditStatusResponse>
  <GetCnAuditStatusHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <CnAuditStatus>pass</CnAuditStatus>
  </GetCnAuditStatusHeader>
</GetCnAuditStatusResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_cn_audit_status&contact_id=testcontactid
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_cn_audit_status&contact_id=testcontactid
响应 (JSON格式)
{
  "GetCnAuditStatusResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "CnAuditStatus": "pass"
  }
}
 

创建联系人命令

支持多线程
支持 API 沙盒

若调用创建联系人命令,则应包含以下参数:

创建联系人请求参数
说明
organization (optional)机构信息
name名称
email电子邮件
phonenum电话号码
phonecc电话国家代码
faxnum (optional)传真号码
faxcc (optional)传真国家代码
address1地址1
address2 (optional)地址 2
city城市
state (optional)省份
zip邮政编码
country国家
结果 XML 标签
说明
<CreateContactResponse></CreateContactResponse>响应 XML 文档的根节点
<CreateContactHeader></CreateContactHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<CreateContactContent></CreateContactContent>新联系人 ID,仅在状态为 "success" 时使用

创建联系人示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox 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
响应 (XML 格式)
<CreateContactResponse>
  <CreateContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateContactHeader>
  <CreateContactContent>
    <ContactId>1234</ContactId>
  </CreateContactContent>
</CreateContactResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox 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
响应 (JSON格式)
{
   "CreateContactResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "CreateContactContent":{
         "ContactId":"0"
      }
   }
}
 

编辑联系人命令

支持多线程
支持 API 沙盒

如果调用 edit contact 命令, 则应包含以下参数:

编辑联系人请求参数
说明
contact_id你想编辑的联系人 ID
organization (optional)机构信息
name名称
email电子邮件
phonenum电话号码
phonecc电话国家代码
faxnum (optional)传真号码
faxcc (optional)传真国家代码
address1地址1
address2 (optional)地址 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

编辑联系人示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox 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
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<EditContactResponse>
  <EditContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </EditContactHeader>
  <EditContactContent>
    <ContactId>0</ContactId>
  </EditContactContent>
</EditContactResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox 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
响应 (JSON格式)
{
  "EditContactResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "EditContactContent": {
      "ContactId": "0"
    }
  }
}
请求 (CSV 格式)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
沙盒请求 (CSV 格式)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox 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
响应 (CSV 格式)
ok,

success,
,
 

删除联系人命令

支持多线程
支持 API 沙盒

如果调用删除联系人命令, 则应包含以下参数:

删除联系人请求参数
说明
contact_id您要删除的联系人ID, 请确保用逗号分隔
结果 XML 标签
说明
<DeleteContactResponse></DeleteContactResponse>响应 XML 文档的根节点
<DeleteContactHeader></DeleteContactHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

删除联系人示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_contact&contact_id=0
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_contact&contact_id=0
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteContactResponse>
  <DeleteContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteContactHeader>
</DeleteContactResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_contact&contact_id=0
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_contact&contact_id=0
响应 (JSON格式)
{
  "DeleteContactResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

联系人列表命令

支持多线程
支持 API 沙盒

此命令仅支持 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 验证状态

联系人列表示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=contact_list
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=contact_list
响应 (XML 格式)
<?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>
        <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>
        <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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=contact_list
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=contact_list
响应 (JSON格式)
{
  "ContactListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ContactList": [
      {
        "ContactId": "0",
        "Organization": "",
        "Name": "Jack tester",
        "Email": "",
        "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": "",
        "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"
      }
    ]
  }
}
 

获取联系人命令

支持多线程
支持 API 沙盒

此命令仅支持 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 验证状态

获取联系人示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_contact&contact_id=10000
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_contact&contact_id=10000
响应 (XML 格式)
<?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>
        <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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_contact&contact_id=10000
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_contact&contact_id=10000
响应 (JSON格式)
{
  "GetContactResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetContact": {
      "ContactId": "12345",
      "Organization": "org",
      "Name": "name",
      "Email": "",
      "PhoneCc": "1",
      "PhoneNum": "555.555.5233",
      "FaxCc": "",
      "FaxNum": "",
      "Address1": "address1",
      "Address2": "address2",
      "City": "city",
      "State": "state",
      "ZipCode": "zipcode",
      "Country": "country",
      "GtldVerified": "no"
    }
  }
}
 

设置联系人欧盟设置命令

支持多线程
支持 API 沙盒

调用 set contact eu setting 命令时,应包含以下参数:

设置联系人 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

设置联系人 EU 设置示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactEUSettingResponse>
  <SetContactEUSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactEUSettingHeader>
  <SetContactEUSettingContent>
    <ContactId>0</ContactId>
  </SetContactEUSettingContent>
</SetContactEUSettingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
响应 (JSON格式)
{
  "SetContactEUSettingResponse": {
    "ResponseCode: ": "0",
    "Status": "Success",
    "SetContactEUSettingContent": {
      "ContactId: ": "0"
    }
  }
}
 

设置联系人 LV 设置命令

支持多线程
支持 API 沙盒

调用设置联系人 lv 设置命令时, 应包含以下参数:

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

设置联系人 Lv 的配置示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactLvSettingResponse>
  <SetContactLvSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactLvSettingHeader>
  <SetContactLvSettingContent>
    <ContactId>0</ContactId>
  </SetContactLvSettingContent>
</SetContactLvSettingResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
响应 (JSON格式)
{
  "SetContactLvSettingResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetContactLvSettingContent": {
      "ContactId: ": "0"
    }
  }
}

设置联系人 LV 设置示例

请求 (CSV 格式)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
沙盒请求 (CSV 格式)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
响应 (CSV 格式)
ok,success,0
 

设置联系人 LT 设置命令

支持多线程
支持 API 沙盒

调用设置联系人 LT 设置命令时,需包含以下参数:

设置联系人 LT 设置请求参数
说明
contact_id你想编辑的联系人 ID
organization_code需先设置联系人组织,之后才能设置联系人组织代码。
结果 XML 标签
说明
<SetContactLtSettingResponse></SetContactLtSettingResponse>响应 XML 文档的根节点
<SetContactLtSettingHeader></SetContactLtSettingHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<SetContactLtSettingContent></SetContactLtSettingContent>响应内容
<ContactId></ContactId>联系人 ID

设置联系人 LT 设置示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactLtSettingResponse>
  <SetContactLtSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactLtSettingHeader>
  <SetContactLtSettingContent>
    <ContactId>0</ContactId>
  </SetContactLtSettingContent>
</SetContactLtSettingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
响应 (JSON格式)
{
  "SetContactLtSettingResponse": {
    "ResponseCode:": "0",
    "Status": "Success",
    "SetContactLtSettingContent": {
      "ContactId": "0"
    }
  }
}
 

获取名称服务器命令

支持多线程
支持 API 沙盒

如果调用 get name server 命令, 则应包含以下参数:

获取名称服务器的请求参数
说明
domain您想获取名称服务器信息的域名, 每次请求只能拉取 1 个域名的名称服务器信息.
结果 XML 标签
说明
<GetNsResponse></GetNsResponse>响应 XML 文档的根节点
<GetNsHeader></GetNsHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<NsContent></NsContent>响应内容
<Host></Host>服务器的主机名
<NsName></NsName>服务器名称

获取 NS 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_ns&domain=mydomain.com
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_ns&domain=mydomain.com
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_ns&domain=mydomain.com
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_ns&domain=mydomain.com
响应 (JSON格式)
{
  "GetNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "NsContent": {
      "Host0": "ns1.mydomain.com",
      "Host1": "ns2.mydomain.com"
    }
  }
}
 

添加域名服务器 命令

支持多线程
支持 API 沙盒

调用 添加域名服务器 命令时,应包含以下参数:

添加域名服务器 请求参数
说明
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

添加 NS 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=add_ns&host=ns1.mydomain.com
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=add_ns&host=ns1.mydomain.com
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=add_ns&host=ns1.mydomain.com
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=add_ns&host=ns1.mydomain.com
响应 (JSON格式)
{
  "AddNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AddNsContent": {
      "Server": {
        "Host": "ns1.mydomain.com",
        "ServerId": 0
      }
    }
  }
}
 

注册域名服务器 命令

支持多线程
支持 API 沙盒

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

注册域名服务器 请求参数
说明
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

注册域名服务器 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
响应 (XML 格式)
<RegisterNsResponse>
  <RegisterNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterNsHeader>
  <RegisterNsContent>
    <Server>
      <Host>domain1.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </RegisterNsContent>
</RegisterNsResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
响应 (JSON格式)
{
   "RegisterNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "RegisterNsContent":{
         "Server":{
            "Host":"ndomain1.com",
            "ServerId":"0"
         }
      }
   }
}
 

设置名称服务器 IP 命令

支持多线程
支持 API 沙盒

若调用 set name server 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" 时使用。

设置名称服务器 IP 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
响应 (XML 格式)
<SetNsIpResponse>
  <SetNsIpHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsIpHeader>
</SetNsIpResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
响应 (JSON格式)
{
   "SetNsIpResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

删除名称服务器命令

支持多线程
支持 API 沙盒

调用删除域名服务器命令时, 应包含以下参数:

删除名称服务器请求参数
说明
server_id你想要删除的 域名服务器 的 ID, 请确保它们以逗号分隔
结果 XML 标签
说明
<DeleteNsResponse></DeleteNsResponse>响应 XML 文档的根节点
<DeleteNsHeader></DeleteNsHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

删除 NS 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_ns&server_id=0
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_ns&server_id=0
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_ns&server_id=0
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_ns&server_id=0
响应 (JSON格式)
{
  "DeleteNsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

按域名删除名称服务器命令

支持多线程
支持 API 沙盒

若通过域名命令调用删除名称服务器,则需包含以下参数:

按域名删除名称服务器的请求参数
说明
server_domain名称服务器的名称. 例如: ns1.testnameserver.com
结果 XML 标签
说明
<DeleteNsResponse></DeleteNsResponse>响应 XML 文档的根节点
<DeleteNsHeader></DeleteNsHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

按域名删除名称服务器示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
响应 (XML 格式)
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
响应 (JSON格式)
{
   "DeleteNsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

服务器列表命令

支持多线程
支持 API 沙盒

此命令仅支持 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

服务器列表示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=server_list
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=server_list
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=server_list
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=server_list
响应 (JSON格式)
{
  "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"
          }
        ]
      }
    ]
  }
}
 

获取域名服务器设置命令

支持多线程
支持 API 沙盒

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

获取域名服务器设置的请求参数
说明
domain您要获取名称服务器设置的域名,每次请求只能拉取 1 个域名的名称服务器设置。
结果 XML 标签
说明
<GetDnsResponse></GetDnsResponse>响应 XML 文档的根节点
<GetDnsHeader></GetDnsHeader>响应头
<ResponseCode></ResponseCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<GetDnsContent></GetDnsContent>响应内容
<NameServerSettings></NameServerSettings>域名的 域名服务器设置
<Type></Type>域名的名称服务器类型

获取域名服务器设置示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_dns&domain=mydomain.com
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_dns&domain=mydomain.com
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_dns&domain=mydomain.com
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_dns&domain=mydomain.com
响应 (JSON格式)
{
  "GetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetDns": {
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      }
    }
  }
}
 

账户信息命令

支持多线程
支持 API 沙盒

此命令仅支持 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>是否带广告

账户信息示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=account_info
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=account_info
响应 (XML 格式)
<?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>
      <AvatarUrl>test avatar url</AvatarUrl>
      <Contact>
        <Organization/>
        <Name>testname test</Name>
        <Email></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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=account_info
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=account_info
响应 (JSON格式)
{
  "AccountInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AccountInfo": {
      "Username": "testname",
      "ForumName": "test forum name",
      "AvatarUrl": "test avatar url",
      "Contact": {
        "Organization": "",
        "Name": "testname test",
        "Email": "",
        "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"
        }
      }
    }
  }
}
 

获取账户余额命令

支持多线程
支持 API 沙盒

此命令仅支持 XML 和 JSON 格式:

获取账户余额请求参数
说明
N/A无需额外参数
结果 XML 标签
说明
<GetAccountBalanceResponse></GetAccountBalanceResponse>响应 XML 文档的根节点XML 文档
<GetAccountBalanceHeader></GetAccountBalanceHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<GetAccountBalanceContent></GetAccountBalanceContent>响应内容
<Balance></Balance>账户余额

获取账户余额示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_account_balance
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_account_balance
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_account_balance
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_account_balance
响应 (JSON格式)
{
  "GetAccountBalanceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BalanceList": [
      {
        "Currency": "USD",
        "Amount": "300.00"
      }
    ]
  }
}
 

设置默认 Whois

支持多线程
支持 API 沙盒

如果调用设置默认 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" 时使用。

设置默认 Whois 示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
响应 (XML 格式)
<SetDefaultWhoisResponse>
   <SetDefaultWhoisHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultWhoisHeader>
</SetDefaultWhoisResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
响应 (JSON格式)
{
   "SetDefaultWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认 域名服务器 命令

支持多线程
支持 API 沙盒

如果调用设置默认 域名服务器 命令,需包含以下参数:

设置默认 域名服务器 请求参数
说明
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 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
响应 (JSON格式)
{
  "SetDefaultNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetDefaultNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}
 

设置默认 域名停靠 命令

支持多线程
支持 API 沙盒

如果调用设置默认 域名停靠 命令,则应包含以下参数:

设置默认 域名停靠 请求参数
说明
with_ads (optional)不想要第三方广告的话, 就把这个参数传 "no", 默认可是 "yes"
结果 XML 标签
说明
<SetDefaultParkingResponse></SetDefaultParkingResponse>响应 XML 文档的根节点
<SetDefaultParkingHeader></SetDefaultParkingHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置默认 域名停靠 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_parking&folder_id=0&with_ads=no
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_parking&folder_id=0&with_ads=no
响应 (XML 格式)
<SetDefaultParkingResponse>
   <SetDefaultParkingHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultParkingHeader>
</SetDefaultParkingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_parking&folder_id=0&with_ads=no
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_parking&folder_id=0&with_ads=no
响应 (JSON格式)
{
   "SetDefaultParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认转发命令

支持多线程
支持 API 沙盒

若调用设置默认转发的命令,则需包含以下参数:

设置默认转发请求参数
说明
forward_url你希望域名转发到的 URL。请注意,该参数必须为 已编码 以便 API 调用能被正确解析.
is_temp (optional)您所需的域名转发状态,默认值为 "temporary";如需永久转发,请将此参数设为 "no"
结果 XML 标签
说明
<SetDefaultForwardingResponse></SetDefaultForwardingResponse>响应 XML 文档的根节点
<SetDefaultForwardingHeader></SetDefaultForwardingHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置默认转发示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
响应 (XML 格式)
<SetDefaultForwardingResponse>
  <SetDefaultForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultForwardingHeader>
</SetDefaultForwardingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
响应 (JSON格式)
{
   "SetDefaultForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认隐身命令

支持多线程
支持 API 沙盒

如果调用 set default stealth 命令,则应包含以下参数:

设置默认隐身请求参数
说明
stealth_url你希望域名转发到的 URL。请注意,该参数必须为 已编码 以便 API 调用能被正确解析.
stealth_title (optional)页面标题
结果 XML 标签
说明
<SetDefaultStealthResponse></SetDefaultStealthResponse>响应 XML 文档的根节点
<SetDefaultStealthHeader></SetDefaultStealthHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置默认隐身转发示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
响应 (XML 格式)
<SetDefaultStealthResponse>
  <SetDefaultStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultStealthHeader>
</SetDefaultStealthResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
响应 (JSON格式)
{
   "SetDefaultStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认主机命令

支持多线程
支持 API 沙盒

如果调用设置默认主机命令, 则应包含以下参数:

设置默认托管请求参数
说明
hosting_type您想要的默认托管类型,可在 "advanced" 和 "basic" 中选择
结果 XML 标签
说明
<SetDefaultHostingResponse></SetDefaultHostingResponse>响应 XML 文档的根节点
<SetDefaultHostingHeader></SetDefaultHostingHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置默认托管示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_hosting&hosting_type=advanced
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_hosting&hosting_type=advanced
响应 (XML 格式)
<SetDefaultHostingResponse>
  <SetDefaultHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultHostingHeader>
</SetDefaultHostingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_hosting&hosting_type=advanced
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_hosting&hosting_type=advanced
响应 (JSON格式)
{
   "SetDefaultHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认 DNS 命令

支持多线程
支持 API 沙盒

若调用设置默认 DNS 命令,则应包含以下参数:

( 此命令已过时且不再推荐, 请改用设置默认 DNS2 命令 )

设置默认 DNS 请求参数
说明
main_record_type主记录类型
main_record为您的域名指定 DNS 记录
main_txt (optional)为您的域名指定一条 TXT 记录。如果 main_record_type 为 aaaa 且指定了 main_record2,最多可设置 3 条 main_txts;否则最多可设置 4 条 main_txts。
main_record2主记录 2,仅在 "main_record_type" 为 "aaaa" 时才会用到。其值必须采用 ipv4 格式。
subdomain0 - subdomain99 (optional)子域名 记录
sub_record_type0 - sub_record_type99 (optional)子域名 记录类型
sub_record0 - sub_record99 (optional)IP 地址或目标主机
mx_host0 - mx_host2 (optional)为您的域名指定邮件主机,distance0 表示最高优先级。
mx_distance0 - mx_distance2 (optional)Distance0 的优先级最高
ttl (optional)生存时间
结果 XML 标签
说明
<SetDefaultDnsResponse></SetDefaultDnsResponse>响应 XML 文档的根节点
<SetDefaultDnsHeader></SetDefaultDnsHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置默认 DNS 示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
响应 (XML 格式)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
响应 (JSON格式)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认 DNS2 命令

支持多线程
支持 API 沙盒

若调用设置默认 DNS 命令,则应包含以下参数:

设置默认 DNS2 请求参数
说明
main_record_type0 - main_record_type19主记录类型
main_record0 - main_record19为您的域名指定 DNS 记录
main_recordx0 - main_recordx19MX 距离, 转发类型, 隐形转发标题或 电子邮件 别名, 当 main_record 是 "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "电子邮件" 时, 这些就是必填项
subdomain0 - subdomain99 (optional)子域名 记录
sub_record_type0 - sub_record_type99 (optional)子域名 记录类型
sub_record0 - sub_record99 (optional)子域名 IP 地址或目标主机
sub_recordx0 - subdo_recordx99MX 距离、转发类型、隐形转发标题或 电子邮件 别名,当 sub_record_type 为 "a"、"aaaa"、"cname"、"forward"、"txt"、"srv"、"mx"、"stealth"、"电子邮件" 时必填。
ttl (optional)生存时间
结果 XML 标签
说明
<SetDefaultDnsResponse></SetDefaultDnsResponse>响应 XML 文档的根节点
<SetDefaultDnsHeader></SetDefaultDnsHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置默认 DNS2 示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
响应 (XML 格式)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
响应 (JSON格式)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

支持多线程
支持 API 沙盒

如果调用设置默认 电子邮件 转发命令, 应包含以下参数:

设置默认 电子邮件 转发请求参数
说明
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" 时使用。

设置默认 电子邮件 转发示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
响应 (XML 格式)
<SetDefaultEmailForwardingResponse>
  <SetDefaultEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultEmailForwardingHeader>
</SetDefaultEmailForwardingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
响应 (JSON格式)
{
   "SetDefaultEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置清除默认设置命令

支持多线程
支持 API 沙盒

如果调用设置清除默认设置的命令,需包含以下参数:

设置清除默认设置请求参数
说明
service你想清除的服务,可以是 "forward"、"stealth"、"email_forwarding"、"dns" 和 "nameservers"。
结果 XML 标签
说明
<SetClearDefaultSettingResponse></SetClearDefaultSettingResponse>响应 XML 文档的根节点
<SetClearDefaultSettingHeader></SetClearDefaultSettingHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置清除默认设置的示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_default_setting&service=nameservers
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_clear_default_setting&service=nameservers
响应 (XML 格式)
<SetClearDefaultSettingResponse>
  <SetClearDefaultSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDefaultSettingHeader>
</SetClearDefaultSettingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_default_setting&service=nameservers
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_clear_default_setting&service=nameservers
响应 (JSON格式)
{
   "SetClearDefaultSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认的 续费选项 命令

支持多线程
支持 API 沙盒

调用设置默认 续费选项 命令时,应包含以下参数:

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

设置默认 续费选项 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_renew_option&renew_option=auto
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_renew_option&renew_option=auto
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<SetDefaultRenewOptionResponse>
  <SetDefaultRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultRenewOptionHeader>
</SetDefaultRenewOptionResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_renew_option&renew_option=auto
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_renew_option&renew_option=auto
响应 (JSON格式)
{
  "SetDefaultRenewOptionResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

创建文件夹命令

支持多线程
支持 API 沙盒

如果调用创建文件夹命令, 则应包含以下参数:

创建文件夹请求参数
说明
folder_name您想创建的文件夹名称
结果 XML 标签
说明
<FolderCreateResponse></FolderCreateResponse>响应 XML 文档的根节点
<FolderCreateHeader></FolderCreateHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<FolderCreateContent></FolderCreateContent>响应内容
<FolderName></FolderName>文件夹名称
<FolderId></FolderId>新文件夹的 ID

创建文件夹示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=create_folder&folder_name=new
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=create_folder&folder_name=new
响应 (XML 格式)
<FolderCreateResponse>
  <FolderCreateHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </FolderCreateHeader>
  <FolderCreateContent>
    <FolderName>new</FolderName>
    <FolderId>1</FolderId>
  </FolderCreateContent>
</FolderCreateResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=create_folder&folder_name=new
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=create_folder&folder_name=new
响应 (JSON格式)
{
   "FolderCreateResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "FolderCreateContent":{
         "FolderName":"new",
         "FolderId":"1"
      }
   }
}
 

删除文件夹命令

支持多线程
支持 API 沙盒

若调用 set Whois 命令, 应包含以下参数:

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

删除文件夹示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_folder&folder_id=0,1
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_folder&folder_id=0,1
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteFolderResponse>
  <DeleteFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteFolderHeader>
</DeleteFolderResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_folder&folder_id=0,1
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_folder&folder_id=0,1
响应 (JSON格式)
{
  "DeleteFolderResponse": {
    "SuccessCode": 0,
    "Status": "success"
  }
}
 

设置文件夹 Whois 命令

支持多线程
支持 API 沙盒

如果调用 set folder Whois 命令, 则应包含以下参数:

设置文件夹 Whois 请求参数
说明
folder_id您想设置的文件夹 ID
registrant_contact域名的注册人信息
admin_contact域名的管理员信息
technical_contact域名的技术信息
billing_contact此域名的账单信息
enable (optional)如果希望将此 Whois 设置应用于未来移入此文件夹的域名,可将此参数设为 "yes"
sync (optional)若想同步此文件夹中所有域名的 Whois 设置, 可使用此参数并设为 "yes"
结果 XML 标签
说明
<SetFolderWhoisResponse></SetFolderWhoisResponse>响应 XML 文档的根节点
<SetFolderWhoisHeader></SetFolderWhoisHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置文件夹 Whois 示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
响应 (XML 格式)
<SetFolderWhoisResponse>
  <SetFolderWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderWhoisHeader>
</SetFolderWhoisResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
响应 (JSON格式)
{
   "SetFolderWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

支持多线程
支持 API 沙盒

如果调用设置文件夹 域名服务器 命令,应包含以下参数:

设置文件夹 域名服务器 请求参数
说明
fold_id要设置的文件夹 ID, 每次请求只能设置 1 个文件夹
ns0 - ns12为你的域名设置要使用的 域名服务器, 你最多可指定 13 个 域名服务器, 但它们必须已经存在于你的账户中
enable (optional)如果您想将此 域名服务器 设置应用于今后移入此文件夹的域名,可将此参数设为 "yes"
sync (optional)如果您想同步此文件夹中所有域名的名称服务器设置, 您可以将此参数设为 "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

设置文件夹 Ns 示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
响应 (XML 格式)
<?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>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
响应 (JSON格式)
{
  "SetFolderNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetFolderNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}
 

设置文件夹 域名停靠 指令

支持多线程
支持 API 沙盒

如果调用设置文件夹 域名停靠 命令, 则应包含以下参数:

设置文件夹 域名停靠 的请求参数
说明
folder_id要设置的文件夹 ID, 每次请求只能设置 1 个文件夹
with_ads (optional)不想要第三方广告的话, 就把这个参数传 "no", 默认可是 "yes"
enable (optional)如果你想让这项 域名停靠 设置应用于今后移入此文件夹的域名,可将此参数设为 "yes"。
sync (optional)如果你想同步此文件夹中所有域名的 域名停靠 设置,可将此参数设为 "yes"
结果 XML 标签
说明
<SetFolderParkingResponse></SetFolderParkingResponse>响应 XML 文档的根节点
<SetFolderParkingHeader></SetFolderParkingHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置文件夹 域名停靠 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_parking&folder_id=0&with_ads=no
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_parking&folder_id=0&with_ads=no
响应 (XML 格式)
<SetFolderParkingResponse>
  <SetFolderParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderParkingHeader>
</SetFolderParkingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_parking&folder_id=0&with_ads=no
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_parking&folder_id=0&with_ads=no
响应 (JSON格式)
{
   "SetFolderParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹转发指令

支持多线程
支持 API 沙盒

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

设置文件夹转发请求参数
说明
folder_id您想设置的文件夹 ID
forward_url你希望域名转发到的 URL。请注意,该参数必须为 已编码 以便 API 调用能被正确解析.
is_temp (optional)您所需的域名转发状态,默认值为 "temporary";如需永久转发,请将此参数设为 "no"
enable (optional)如果希望以后移进这个文件夹的域名也套用这条转发设置, 给此参数传 "yes" 就行
sync (optional)如果希望同步此文件夹中所有域名的转发设置,可将此参数设为 "yes"
结果 XML 标签
说明
<SetFolderForwardingResponse></SetFolderForwardingResponse>响应 XML 文档的根节点
<SetFolderForwardingHeader></SetFolderForwardingHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置文件夹转发示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
响应 (XML 格式)
<SetFolderForwardingResponse>
  <SetFolderForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderForwardingHeader>
</SetFolderForwardingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
响应 (JSON格式)
{
   "SetFolderForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹隐身命令

支持多线程
支持 API 沙盒

如果调用 set folder stealth 命令,则应包含以下参数:

设置文件夹隐身请求参数
说明
folder_id您要设置的文件夹 ID
stealth_url你希望域名转发到的 URL。请注意,该参数必须为 已编码 以便 API 调用能被正确解析.
stealth_title (optional)页面标题
enable (optional)如果您想将此隐身设置应用到今后移入此文件夹的域名, 您可以将此参数设为 "yes"
sync (optional)如果您想同步此文件夹中所有域名的 stealth 设置,可将此参数设为 "yes"
结果 XML 标签
说明
<SetFolderStealthResponse></SetFolderStealthResponse>响应 XML 文档的根节点
<SetFolderStealthHeader></SetFolderStealthHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置文件夹隐身示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes
响应 (XML 格式)
<SetFolderStealthResponse>
  <SetFolderStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderStealthHeader>
</SetFolderStealthResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes
响应 (JSON格式)
{
   "SetFolderStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹托管命令

支持多线程
支持 API 沙盒

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

设置文件夹托管请求参数
说明
folder_id您想设置的文件夹 ID
hosting_type你想要的托管类型,可在 "advanced" 和 "basic" 中选择。
enable (optional)如果您想将此托管设置应用到今后移入此文件夹的域名, 您可以将此参数设为 "yes"
even (optional)若想同步此文件夹中所有域名的主机设置, 可使用此参数并设为 "yes"
结果 XML 标签
说明
<SetFolderHostingResponse></SetFolderHostingResponse>响应 XML 文档的根节点
<SetFolderHostingHeader></SetFolderHostingHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置文件夹托管示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
响应 (XML 格式)
<SetFolderHostingResponse>
  <SetFolderHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHostingHeader>
</SetFolderHostingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
响应 (JSON格式)
{
   "SetFolderHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹 DNS 命令

支持多线程
支持 API 沙盒

若调用设置文件夹 DNS 命令, 则应包含以下参数:

( 此命令已过时且不推荐使用, 请改用 Set Folder DNS2 命令 )

设置文件夹 DNS 请求参数
说明
folder_id你要设置的文件夹 ID
main_record_type主记录类型
main_record为您的域名指定 DNS 记录
main_record为您的域名指定 DNS 记录
with_ads (optional)为您的域名指定一条 TXT 记录。如果 main_record_type 为 aaaa 且指定了 main_record2,最多可设置 3 条 main_txts;否则最多可设置 4 条 main_txts。
main_record2主记录 2,仅在 "main_record_type" 为 "aaaa" 时才会用到。其值必须采用 ipv4 格式。
subdomain0 - subdomain99 (optional)子域名 记录(可选)
sub_record_type0 - sub_record_type99 (optional)子域名 记录类型
sub_record0 - sub_record99 (optional)IP 地址或目标主机
mx_host0 - mx_host2 (optional)为您的域名指定邮件主机,distance0 表示最高优先级。
mx_distance0 - mx_distance2 (optional)Distance0 优先级最高
ttl (optional)生存时间
enable (optional)若希望今后移入此文件夹的域名也套用该 DNS 设置,可将此参数设为 "yes"
sync (optional)若想把此文件夹里所有域名的 DNS 服务器设置都同步一致, 给这个参数传 "yes" 即可
结果 XML 标签
说明
<SetFolderDnsResponse></SetFolderDnsResponse>响应 XML 文档的根节点
<SetFolderDnsHeader></SetFolderDnsHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置文件夹 DNS 示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
响应 (XML 格式)
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
响应 (JSON格式)
{
   "SetFolderDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹 DNS2 命令

支持多线程
支持 API 沙盒

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

设置文件夹 DNS2 请求参数
说明
folder_id你要设置的文件夹 ID
main_record_type0 - main_record_type19主记录类型,应为 "a"、"aaaa"、"cname"、"forward"、"txt"、"mx"、"stealth"、"电子邮件"
main_record0 - main_record19为您的域名指定 DNS 记录
main_recordx0 - main_recordx19MX 距离、转发类型、隐形转发标题或 电子邮件 别名;当 main_record_type 为 "forward"、"mx"、"stealth"、"电子邮件" 时必填
subdomain0 - subdomain99 (optional)子域名 记录(可选)
sub_record_type0 - sub_record_type99 (optional)子域名 记录类型,应为 "a"、"aaaa"、"cname"、"forward"、"txt"、"srv"、"mx"、"stealth"、"电子邮件"
sub_record0 - sub_record99 (optional)IP 地址或目标主机
sub_recordx0 - sub_recordx99 (optional)Mx 距离、转发类型、隐形转发标题或 电子邮件 别名,在 sub_record_type 为 "forward"、"mx"、"stealth"、"电子邮件" 时为必填项。
ttl (optional)生存时间
enable (optional)若希望今后移入此文件夹的域名也套用该 DNS 设置,可将此参数设为 "yes"
sync (optional)若想把此文件夹里所有域名的 DNS 服务器设置都同步一致, 给这个参数传 "yes" 即可
结果 XML 标签
说明
<SetFolderDnsResponse></SetFolderDnsResponse>响应 XML 文档的根节点
<SetFolderDnsHeader></SetFolderDnsHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置文件夹 Dns2 示例

请求 (XML 格式)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
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
请求 (JSON格式)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
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
响应 (JSON格式)
{
  "SetFolderDnsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

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

支持多线程
支持 API 沙盒

如果调用设置文件夹 电子邮件 转发命令,应包含以下参数:

设置文件夹 电子邮件 转发请求参数
说明
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 (optional)如果您想将此设置应用到今后移入此文件夹的域名, 您可以将此参数设为 "yes"
sync (optional)若想同步此文件夹中所有域名的这项设置, 可使用此参数并设为 "yes"
结果 XML 标签
说明
<SetFolderEmailForwardingResponse></SetFolderEmailForwardingResponse>响应 XML 文档的根节点
<SetFolderEmailForwardingHeader></SetFolderEmailForwardingHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置文件夹 电子邮件 转发示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
响应 (XML 格式)
<SetFolderEmailForwardingResponse>
  <SetFolderEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderEmailForwardingHeader>
</SetFolderEmailForwardingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
响应 (JSON格式)
{
   "SetFolderEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置清除文件夹设置命令

支持多线程
支持 API 沙盒

如果调用设置清除文件夹设置的命令,需包含以下参数:

设置清除文件夹设置的请求参数
说明
folder_id您想设置的文件夹 ID
service你想清除的服务,可以是 "forward"、"stealth"、"email_forwarding"、"dns" 和 "nameservers"。
结果 XML 标签
说明
<SetClearFolderSettingResponse></SetClearFolderSettingResponse>响应 XML 文档的根节点
<SetClearFolderSettingHeader></SetClearFolderSettingHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置清除文件夹配置示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
响应 (XML 格式)
<SetClearFolderSettingResponse>
  <SetClearFolderSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearFolderSettingHeader>
</SetClearFolderSettingResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
响应 (JSON格式)
{
   "SetClearFolderSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹名称命令

支持多线程
支持 API 沙盒

调用“设置文件夹名称”命令时,记得带上以下参数:

设置文件夹名称请求参数
说明
folder_id您要设置的文件夹 ID
folder_name新文件夹名称
结果 XML 标签
说明
<SetFolderNameResponse></SetFolderNameResponse>响应 XML 文档的根节点
<SetFolderNameHeader></SetFolderNameHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置文件夹名称示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_name&folder_id=0&folder_name=new
响应 (XML 格式)
<SetFolderNameResponse>
  <SetFolderNameHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderNameHeader>
</SetFolderNameResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_name&folder_id=0&folder_name=new
响应 (JSON格式)
{
   "SetFolderNameResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹 续费选项 命令

支持多线程
支持 API 沙盒

如果调用设置文件夹 续费选项 命令,需包含以下参数:

设置文件夹 续费选项 请求参数
说明
folder_id要设置的文件夹 ID, 每次请求只能设置 1 个文件夹
renew_option你想设置到该文件夹的 续费选项;它可以是 "donot"、"auto" 或 "reset"。
enable (optional)如果您想将此续费设置应用到今后移入此文件夹的域名, 您可以将此参数设为 "yes"
sync (optional)如果你想同步此文件夹中所有域名的续费设置,可以将此参数设为 "yes"。
结果 XML 标签
说明
<Response></Response>响应 XML 文档的根节点
<ResponseHeader></ResponseHeader>响应头
<ResponseCode></ResponseCode>响应代码,"0" 表示成功,"-1" 表示失败
<Error></Error>错误信息, 仅在响应代码为 "-1" 时使用

设置文件夹 续费选项 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
响应 (XML 格式)
<SetFolderRenewOptionResponse>
  <SetFolderRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderRenewOptionHeader>
</SetFolderRenewOptionResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
响应 (JSON格式)
{
   "SetFolderRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

文件夹列表命令

支持多线程
支持 API 沙盒

此命令仅支持 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>域名锁定状态

文件夹列表示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=folder_list
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=folder_list
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=folder_list
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=folder_list
响应 (JSON格式)
{
  "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"
        }
      }
    ]
  }
}
 

添加 域名抢注 请求命令

支持多线程
不支持 API 沙盒

调用添加 域名抢注 请求命令时, 应包含以下参数:

添加 域名抢注 请求的请求参数
说明
domain您想添加并同意在 Dynadot 抢到时付款的域名(s), 每次请求最多可添加 100 个域名, 它们应以逗号分隔
结果 XML 标签
说明
<AddBackorderRequestResponse></AddBackorderRequestResponse>响应 XML 文档的根节点
<AddBackorderRequestHeader></AddBackorderRequestHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

添加 域名抢注 请求示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
响应 (XML 格式)
<AddBackorderRequestResponse>
  <AddBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddBackorderRequestHeader>
</AddBackorderRequestResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
响应 (JSON格式)
{
   "AddBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

删除 域名抢注 请求命令

支持多线程
不支持 API 沙盒

如果调用删除 域名抢注 请求命令, 应包含以下参数:

删除 域名抢注 请求的请求参数
说明
domain您想从 域名抢注 请求列表中移除的域名;每次请求最多可移除 100 个域名,多个域名请用逗号分隔。
结果 XML 标签
说明
<DeleteBackorderRequestResponse></DeleteBackorderRequestResponse>响应 XML 文档的根节点
<DeleteBackorderRequestHeader></DeleteBackorderRequestHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

删除 域名抢注 请求示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_backorder_request&domain=domaindropp.com
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_backorder_request&domain=domaindropp.com
响应 (XML 格式)
<DeleteBackorderRequestResponse>
  <DeleteBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteBackorderRequestHeader>
</DeleteBackorderRequestResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_backorder_request&domain=domaindropp.com
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_backorder_request&domain=domaindropp.com
响应 (JSON格式)
{
   "DeleteBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

域名抢注 请求列表命令

支持多线程
不支持 API 沙盒

调用 域名抢注 请求列表命令,将返回指定账户的 域名抢注 请求列表。若调用此命令,应包含以下参数:

域名抢注 请求列表的请求参数
说明
start_date您想请求的拍卖起始掉落日期,格式为 yyyy-mm-dd,例如 2015-05-05
end_date您要请求的拍卖结束掉落日期,格式为 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 时间,自 1970 年 1 月 1 日 UTC 午夜起的毫秒数)
<BackorderRequestStatus></BackorderRequestStatus>抢注过程中的状态

域名抢注 请求列表示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
响应 (JSON格式)
{
  "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"
      }
    ]
  }
}
请求 (CSV 格式)https://api.dynadot.com/api3.html?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
沙盒请求 (CSV 格式)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
响应 (CSV 格式)
ok,success,Domain,CutoffTime,BackorderRequestStatus,testdrop.com,1403914140000,Active,testdrop3.com,1403914140000,Active,testdrop4.com,1403914140000,Active,testdrop5.com,1403914140000,Active
 

获取公开拍卖命令

支持多线程
不支持 API 沙盒

调用 get open auctions 命令会返回一份正在进行中的拍卖列表。若调用此命令,应包含以下参数:

获取公开拍卖请求参数
说明
currency (optional)返回结果的货币单位,应为 "usd"、"eur" 或 "cny",默认货币为美元
type (optional)您想查看的拍卖类型,应为 "expired"、"user"、"域名抢注" 或 "registry_expired"、"registrar";若想获取多个拍卖类型,可用 "," 分隔每个拍卖类型
count_per_page每页显示多少个实体(最多 1000 个)
page_index 您想查看哪一页的实体
has_bids (optional)当该参数为 true 时, 它将仅返回已有人出价的拍卖. 如果为 false, 它将返回无人出价的拍卖. 如果不传递, 它将返回所有拍卖.
结果 XML 标签
说明
<GetOpenAuctionsResponse></GetOpenAuctionsResponse>获取公开拍卖响应的标签, 它是响应 XML 文档的根节点
<GetOpenAuctionsHeader></GetOpenAuctionsHeader>获取未结拍卖标头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<GetOpenAuctionsContent></GetOpenAuctionsContent>Tag of get open auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<AuctionId></AuctionId>拍卖 ID
<Domain></Domain>拍卖的 域名
<BidPrice></BidPrice>当前出价 拍卖价格
<BidPriceCurrency></BidPriceCurrency>出价货币
<Bids></Bids>竞拍出价 的数量
<EndTime></EndTime>拍卖结束时间
<EndTimestamp></EndTimestamp>拍卖结束日期(Unix 时间,即自 1970 年 1 月 1 日 UTC 午夜起算的毫秒数)
<Revenue></Revenue>拍卖收益
<RevenueCurrency></RevenueCurrency>收益币种
<Visitors></Visitors>域名访客
<Links></Links>域名的 反向链接
<Age></Age>域名年龄

获取公开拍卖示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
响应 (XML 格式)
<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&count_per_page=20&page_index=1

响应

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
.
.
.

请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
响应 (JSON格式)
{
    "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,
            "dyna_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,
            "dyna_appraisal": "-"
        }
        ...
    ]
}
 

获取拍卖详情命令

支持多线程
不支持 API 沙盒

调用获取拍卖详情命令将返回指定拍卖的详细信息。该命令仅支持XML和JSON格式。调用此命令时,应包含以下参数:

获取拍卖详情请求参数
说明
domain拍卖的 域名,IDN(国际化 域名)应使用 punycode,例如 "xn--wkccg.com"。您可以获取多个拍卖,每个域名之间必须用 "," 分隔。
currency (optional)返回结果的货币单位,应为 "usd"、"eur" 或 "cny",默认货币为美元
结果 XML 标签
说明
<GetAuctionDetailsResponse></GetAuctionDetailsResponse>获取拍卖详情响应的标签,即响应 XML 文档的根节点
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>获取 域名抢注 拍卖详情标头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<GetAuctionDetailsContent></GetAuctionDetailsContent>Tag of get auction details content, it's only used when status is "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 时间,即自 1970 年 1 月 1 日 UTC 午夜起算的毫秒数)
<IsPremium></IsPremium>它是否为 精品域名
<RenewalPrice></RenewalPrice>续费价格

获取拍卖详情示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
沙盒请求 (XML 格式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
沙盒请求 (JSON格式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
响应 (JSON格式)
{
  "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": "",
        "dyna_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": []
    }
  ]
}
 

获取 竞拍出价 命令

支持多线程
不支持 API 沙盒

调用 get 竞拍出价 命令,即可获取您参与过的出价列表。调用此命令时,应包含以下参数:

获取 竞拍出价 请求参数
说明
currency (optional)你的出价货币,应为 "usd"、"eur" 或 "cny",默认货币为美元
count_per_page每页显示多少个实体 (最多 50 个)
page_index 您想查看哪一页的实体
结果 XML 标签
说明
<GetAuctionBidsResponse></GetAuctionBidsResponse>获取 竞拍出价 响应的标签,它是响应 XML 文档的根节点
<GetAuctionBidsHeader></GetAuctionBidsHeader>获取 竞拍出价 标头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<GetAuctionBidsContent></GetAuctionBidsContent>Tag of get auction bids content, it's only used when status is "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>拍卖结束时间戳

获取 竞拍出价 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
响应 (XML 格式)
<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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
响应 (JSON格式)
{
    "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
        }
        ...
    ]
}
 

提交拍卖出价命令

支持多线程
不支持 API 沙盒

调用拍卖出价命令将为指定拍卖出价。若调用此命令,应包含以下参数:

提交拍卖出价请求参数
说明
domain拍卖的 域名,IDN(国际化 域名)应使用 punycode,例如 "xn--wkccg.com"
bid_amount您在拍卖中的出价金额,默认币种是美元;也可以用下方的 currency 参数另行指定。
currency (optional)你的出价货币,应为 "usd"、"eur" 或 "cny",默认货币为美元
结果 XML 标签
说明
<PlaceAuctionBidResponse></PlaceAuctionBidResponse>拍卖出价响应标签,也就是响应 XML 文档的根节点
<PlaceAuctionBidHeader></PlaceAuctionBidHeader>拍卖出价请求头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

域名示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
响应 (XML 格式)
<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

请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
响应 (JSON格式)
{
    "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,
            "dyna_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
            }
            ...        ]
    }
}
 

获取已结束拍卖命令

支持多线程
不支持 API 沙盒

调用 get closed auctions 命令会返回指定账户的已关闭拍卖列表. 若调用该命令, 需包含以下参数:

获取已结束拍卖的请求参数
说明
start_date表示拍卖结束时间起点的时间戳,格式为 yyyy-mm-dd,如 2015-05-05
end_date表示拍卖结束时间终点的时间戳,格式为 yyyy-mm-dd,例如 2015-05-05
currency (optional)你的出价货币,应为 "usd"、"eur" 或 "cny",默认货币为美元
结果 XML 标签
说明
<GetClosedAuctionsResponse></GetClosedAuctionsResponse>获取已关闭拍卖响应的标签,它是响应 XML 文档的根节点
<GetClosedAuctionsHeader></GetClosedAuctionsHeader>获取已结束拍卖标题
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<GetClosedAuctionsContent></GetClosedAuctionsContent>Tag of get closed auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "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>您本次拍卖的 代理出价

获取已结束拍卖示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
响应 (JSON格式)
{
  "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"
      }
    ]
  }
}
请求 (CSV 格式)https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
沙盒请求 (CSV 格式)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
响应 (CSV 格式)
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
 

获取打开 域名抢注拍卖 的命令

支持多线程
不支持 API 沙盒

调用 get open 域名抢注拍卖 命令,会返回一个列表,其中包含正在进行的 域名抢注拍卖. 如果调用此命令,应包含以下参数:

获取 Open 域名抢注拍卖 请求参数
说明
currency (optional)返回结果的货币单位,应为 "usd"、"eur" 或 "cny",默认货币为美元
结果 XML 标签
说明
<GetOpenBackorderAuctionsResponse></GetOpenBackorderAuctionsResponse>获取 open 域名抢注拍卖 响应的标签,它是响应 XML 文档的根节点
<GetOpenBackorderAuctionsHeader></GetOpenBackorderAuctionsHeader>获取未结 域名抢注拍卖 标头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<GetOpenBackorderAuctionsContent></GetOpenBackorderAuctionsContent>Tag of get open backorder auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<AuctionId></AuctionId>拍卖 ID
<Domain></Domain>拍卖的 域名
<BidPrice></BidPrice>当前出价 拍卖价格
<BidPriceCurrency></BidPriceCurrency>出价货币
<Bids></Bids>竞拍出价 的数量
<EndTime></EndTime>拍卖结束时间
<EndTimestamp></EndTimestamp>拍卖结束日期(Unix 时间,即自 1970 年 1 月 1 日 UTC 午夜起算的毫秒数)

获取 Open 域名抢注拍卖 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_open_backorder_auctions&currency=usd
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_open_backorder_auctions&currency=usd
响应 (XML 格式)
<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
.
.
.

 

获取 域名抢注 拍卖详情命令

支持多线程
不支持 API 沙盒

调用 get 域名抢注 auction details 命令将返回指定拍卖的详细信息. 该命令仅提供 XML 和 JSON 格式. 调用此命令, 应包含以下参数:

获取拍卖详情请求参数
说明
domain域名抢注 拍卖的 域名,IDN(国际 域名)应使用 punycode,例如 "xn--wkccg.com"。
currency (optional)返回结果的货币单位,应为 "usd"、"eur" 或 "cny",默认货币为美元
结果 XML 标签
说明
<GetBackorderAuctionDetailsResponse></GetBackorderAuctionDetailsResponse>获取拍卖详情响应的标签,即响应 XML 文档的根节点
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>获取拍卖详情请求头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<GetAuctionDetailsContent></GetAuctionDetailsContent>Tag of get auction details content, it's only used when status is "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 时间,即自 1970 年 1 月 1 日 UTC 午夜起算的毫秒数)
<Revenue></Revenue>拍卖收益
<RevenueCurrency></RevenueCurrency>收益币种
<Visitors></Visitors>域名访客
<Links></Links>域名的 反向链接
<Age></Age>域名年龄
<UserIsHighBid></UserIsHighBid>如果用户是最高出价者
<YourCurrentBid></YourCurrentBid>您对指定拍卖的 当前出价 价格. 如果您尚未出价, 该值将为 '-1'
<YourProxyBid></YourProxyBid>您的 代理出价 针对指定拍卖. 若您尚未出价, 其值将为 '-1'

获取 域名抢注 拍卖详情示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
响应 (JSON格式)
{
  "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"
      }
    }
  }
}
 

下达 域名抢注 拍卖出价命令

支持多线程
不支持 API 沙盒

调用 place 域名抢注 拍卖出价命令将为指定的 域名抢注 拍卖出价. 如果调用此命令, 应包含以下参数:

提交 域名抢注 拍卖出价请求参数
说明
domain拍卖的 域名,IDN(国际化 域名)应使用 punycode,例如 "xn--wkccg.com"
bid_amount您在拍卖中的出价金额,默认币种是美元;也可以用下方的 currency 参数另行指定。
currency (optional)你的出价货币,应为 "usd"、"eur" 或 "cny",默认货币为美元
结果 XML 标签
说明
<PlaceBakcorderAuctionBidResponse></PlaceBakcorderAuctionBidResponse>拍卖出价响应标签,也就是响应 XML 文档的根节点
<PlaceBackorderAuctionBidHeader></PlaceBackorderAuctionBidHeader>拍卖出价请求头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

提交 域名抢注 拍卖出价示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
响应 (XML 格式)
<PlaceBakcorderAuctionBidResponse>
 <PlaceBackorderAuctionBidHeader>
   <SuccessCode>0</SuccessCode>
   <Status>success</Status>
 </PlaceBackorderAuctionBidHeader>
</PlaceBakcorderAuctionBidResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
响应 (JSON格式)
{
   "PlaceBakcorderAuctionBidResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
请求 (CSV 格式)https://api.dynadot.com/api3.html?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
沙盒请求 (CSV 格式)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
响应 (CSV 格式)
ok,success
 

获取已关闭的 域名抢注拍卖 命令

支持多线程
不支持 API 沙盒

调用 get closed 域名抢注拍卖 命令,将返回指定账户下已关闭的 域名抢注拍卖 列表。调用该命令时,需带上以下参数:

获取已关闭 域名抢注拍卖 请求参数
说明
start_date拍卖起始日期,格式为 yyyy-mm-dd,例如 2015-05-05
end_date拍卖结束日期,yyyy-mm-dd,例如 2015-05-05
currency (optional)你的出价货币,应为 "usd"、"eur" 或 "cny",默认货币为美元
结果 XML 标签
说明
<GetClosedBackorderAuctionsResponse></GetClosedBackorderAuctionsResponse>获取已关闭拍卖响应的标签,它是响应 XML 文档的根节点
<GetClosedBackorderAuctionsHeader></GetClosedBackorderAuctionsHeader>获取已结束拍卖标题
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<GetClosedBackorderAuctionsContent></GetClosedBackorderAuctionsContent>Tag of get closed auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "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>竞拍出价 的数量

获取已结束的 域名抢注拍卖 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
响应 (JSON格式)
{
  "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"
      }
    ]
  }
}
请求 (CSV 格式)https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
沙盒请求 (CSV 格式)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
响应 (CSV 格式)
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
 

获取 过期域名一口价清仓 命令

支持多线程
不支持 API 沙盒

调用获取 过期域名一口价清仓 命令将获取 过期域名一口价清仓. 此命令仅在 XML 和 JSON 格式下可用. 如果调用此命令, 应包含以下参数:

获取 过期域名一口价清仓 请求参数
说明
currency(optional)返回结果的货币单位,应为 "usd"、"eur" 或 "cny",默认货币为美元
domain(optional)想查询清仓域名就加上这个参数
count_per_page (optional)每页显示多少个实体
page_index (optional)您想查看哪一页的实体
结果 XML 标签
说明
<GetExpiredCloseoutDomainsResponse></GetExpiredCloseoutDomainsResponse>获取 过期域名一口价清仓 响应的标签, 它是响应 XML 文档的根节点
<GetExpiredCloseoutDomainsHeader></GetExpiredCloseoutDomainsHeader>获取 过期域名一口价清仓 标头
<ResponseCode></ResponseCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<GetExpiredCloseoutDomainsContent></GetExpiredCloseoutDomainsContent>Tag of content, it's only used when status is "success"
<CloseoutItem></CloseoutItem>清仓项目
<DomainName></DomainName>该 域名
<DomainNameUtf></DomainNameUtf>该 域名 为 utf 格式
<CurrentPrice></CurrentPrice>当前价格
<isIdn></isIdn>是否为 IDN 域名
<EndTimeStamp></EndTimeStamp>拍卖结束日期(Unix 时间,即自 1970 年 1 月 1 日 UTC 午夜起算的毫秒数)
<RenewalPrice></RenewalPrice>续费价格
<ExpiredRevenue></ExpiredRevenue>清仓收益
<DynaAppraisal></DynaAppraisal>DynaAppraisal
<InboundLinks></InboundLinks>域名的 反向链接
<MonthlyVisitors></MonthlyVisitors>域名访客
<Currency></Currency>货币

获取 过期域名一口价清仓 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
沙盒请求 (XML 格式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
沙盒请求 (JSON格式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
响应 (JSON格式)
{
  "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"
        }
      }
    ]
  }
}
 

购买 过期域名一口价清仓 域名的命令

支持多线程
不支持 API 沙盒

调用“购买 过期域名一口价清仓 域名”命令,将购买指定的 域名。此命令仅支持 XML 和 JSON 格式。调用此命令时,应包含以下参数:

购买 过期域名一口价清仓 域名的请求参数
说明
domain您想购买的域名,每次请求只能输入 1 个域名
currency(optional)返回结果的货币单位,应为 "usd"、"eur" 或 "cny",默认货币为美元
结果 XML 标签
说明
<BuyExpiredCloseoutDomainResponse></BuyExpiredCloseoutDomainResponse>购买 过期域名一口价清仓 域名响应的标签,它是响应 XML 文档的根节点
<BuyExpiredCloseoutDomainHeader></BuyExpiredCloseoutDomainHeader>购买 过期域名一口价清仓 域名标题
<ResponseCode></ResponseCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

购买 过期域名一口价清仓 域名示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
沙盒请求 (XML 格式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<BuyExpiredCloseoutDomainResponse>
  <BuyExpiredCloseoutDomainHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BuyExpiredCloseoutDomainHeader>
</BuyExpiredCloseoutDomainResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
沙盒请求 (JSON格式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
响应 (JSON格式)
{
  "BuyExpiredCloseoutDomainResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

获取列表命令

支持多线程
不支持 API 沙盒

如果调用 get listings 命令, 应包含以下参数:

获取列表请求参数
说明
currency (optional)返回结果的货币单位,应为 "usd"、"eur" 或 "cny",默认货币为美元
exclude_pending_sale (optional)If you don't want to get pending sale lock listings, it should be "yes", default is "no"
show_other_registrar (optional)如果你想获取 其他注册商 列表,应设为 "yes",默认为 "no"。
count_per_page每页显示多少个实体. (最多 20000)
page_index您想查看哪一页的实体.
结果 XML 标签
说明
<GetListingsResponse></GetListingsResponse>响应 XML 文档的根节点XML 文档
<GetListingsHeader></GetListingsHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<GetListingsContent></GetListingsContent>挂牌内容
<Listing></Listing>上架商品内容
<ListingId></ListingId>挂牌 ID
<Domain></Domain>域名
<Price></Price>价格
<InBoundLinks></InBoundLinks>入站链接数量
<Age></Age>域名年限

获取挂牌列表示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
响应 (XML 格式)
<?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>
      <Type>BIN</Type>
      <RegistrationDate>1791875010217</RegistrationDate>
      <ExpirationDate>1791875010217</ExpirationDate>
    </Listing>
    <Listing>
      <ListingId>id2</ListingId>
      <Domain>domain_name2</Domain>
      <Price>2</Price>
      <InboundLinks>2</InboundLinks>
      <Age>2</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
      <Type>MAKE_OFFER</Type>
      <RegistrationDate>1791875010217</RegistrationDate>
      <ExpirationDate>1791875010217</ExpirationDate>
    </Listing>
  </GetListingsContent>
</GetListingsResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
响应 (JSON格式)
{
  "GetListingsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Total": 2,
    "Listing": [
      {
        "ListingId": "id1",
        "Domain": "domain_name1",
        "Price": "1",
        "InboundLinks": "1",
        "Age": "1",
        "PendingSaleLocked": "No",
        "RegistrationDate": 1791875010217,
        "ExpirationDate": 1791875010217,
        "Type": "BIN"
      },
      {
        "ListingId": "id2",
        "Domain": "domain_name2",
        "Price": "2",
        "InboundLinks": "2",
        "Age": "2",
        "PendingSaleLocked": "No",
        "RegistrationDate": 1791875010217,
        "ExpirationDate": 1791875010217,
        "Type": "MAKE_OFFER"
      }
    ]
  }
}
 

获取挂售条目命令

支持多线程
不支持 API 沙盒

如果调用 get listing item 命令,应包含以下参数:

获取挂牌项目请求参数
说明
domain你想获取详情的 域名,每次请求只能输入 1 个域名
currency (optional)返回结果的货币单位,应为 "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>挂牌 ID
<Domain></Domain>域名
<Price></Price>价格
<InBoundLinks></InBoundLinks>入站链接数量
<Age></Age>域名年限

获取列表项示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_listing_item&currency=usd&domain=domain_name
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_listing_item&currency=usd&domain=domain_name
响应 (XML 格式)
<?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>
      <Type>BIN</Type>
      <RegistrationDate>1791875010218</RegistrationDate>
      <ExpirationDate>1791875010218</ExpirationDate>
    </Listing>
  </GetListingsItemContent>
</GetListingsItemResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_listing_item&currency=usd&domain=domain_name
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_listing_item&currency=usd&domain=domain_name
响应 (JSON格式)
{
  "GetListingsItemResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Listing": {
      "ListingId": "id",
      "Domain": "domain_name",
      "Price": "0",
      "InboundLinks": "0",
      "Age": "0",
      "PendingSaleLocked": "No",
      "RegistrationDate": 1791875010218,
      "ExpirationDate": 1791875010218,
      "Type": "BIN"
    }
  }
}
 

一口价 命令

支持多线程
不支持 API 沙盒

如果调用 一口价 命令,则应包含以下参数:

一口价 请求参数
说明
domain您想购买的域名,每次请求只能输入 1 个域名
currency (optional)返回结果所用的币种, 可填 "usd", "eur" 或 "cny", 不填的话, 就按账户默认币种来
price_to_verify (optional)购买前需核验的预期 buy_it_now 价格. 如果实际的 挂牌价格 与此值不符, 请求将失败.
结果 XML 标签
说明
<BuyItNowResponse></BuyItNowResponse>响应 XML 文档的根节点XML 文档
<BuyItNowHeader></BuyItNowHeader>响应头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<Message></Message>它应为 "domain order created", 仅在状态为 "success" 时使用.

一口价 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<BuyItNowResponse>
  <BuyItNowHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </BuyItNowHeader>
  <BuyItNowContent>
    <OrderId>1</OrderId>
  </BuyItNowContent>
</BuyItNowResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
响应 (JSON格式)
{
  "BuyItNowResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderId": 1
  }
}
 

新增线索命令

支持多线程
不支持 API 沙盒

调用“添加新线索”命令,将按 5% 佣金率把您自己的线索导入 Dynadot 系统。

注意:域名将解除锁定,方便买家在接受后立即完成结算。

该命令仅提供 XML 和 JSON 格式。调用此命令时,需包含以下参数:

新增线索请求参数
说明
domain_name要为其添加线索的 域名,每次请求只能填写 1 个域名
lead_type您要设置的线索类型。可选值为 "buy_now"、"make_offer"
price您想为该线索设置的价格
buyer_name买家姓名
buyer_email买家的 电子邮件
结果 XML 标签
说明
<AddNewLeadResponse></AddNewLeadResponse>响应的根节点
<AddNewLeadHeader></AddNewLeadHeader>新增线索标题
<ResponseCode></ResponseCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

添加新潜在客户示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<AddNewLeadResponse>
  <AddNewLeadHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </AddNewLeadHeader>
</AddNewLeadResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
响应 (JSON格式)
{
  "AddNewLeadResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

设置 出售域名 命令

支持多线程
不支持 API 沙盒

该命令支持多线程.

调用 Set 出售域名 命令,即可将您的域名 出售域名 列入 Domain 域名交易市场。此命令仅支持 XML 和 JSON 格式。调用此命令时,应包含以下参数:

设置 出售域名 请求参数
说明
domains您想要将域名 出售域名 列入 Domain 域名交易市场,每次请求只能输入 1 个域名
for_sale_type您可以从以下列表中选择一个值来代表您的销售类型:
> 域名交易市场:
将你的域名出售域名上架到 域名交易市场. 新域名列表将设置为下方输入的类别、子类别和价格。如果设置了实际价格,该域名将可供立即购买并推送给买家。 了解域名出售流程的更多信息 >

> 非卖品:
取消上架
listing_type (optional)您可从下列选项中择一值,用以表示通过市场销售的类型:(当 for_sale_type 为 域名交易市场 时,此项必填)
> buy_now
设置固定价格将使域名可立即购买并推送给买家。
注意: 对于处于 add 宽限期 中的域名, 如果发生销售, 可能不再能进行宽限期删除. 更多信息关于 域名宽限期删除

> make_offer
您可以选择设置最低出价,或留空以接受任意出价金额。
注意: 对于处于 add 宽限期 中的域名, 如果发生销售, 可能不再能进行宽限期删除. 更多信息关于 域名宽限期删除

> buy_now_and_make_offer 设置一口价会让域名可立即购买并推送给买家.
您可以选择设置最低出价,或留空以接受任意出价金额。
注意: 对于处于 add 宽限期 中的域名, 如果发生销售, 可能不再能进行宽限期删除. 更多信息关于 域名宽限期删除
price (optional)你想出售域名的价格. (如果 for_sale_type 是 域名交易市场则必填)
minimum_offer (optional)您愿意接受的域名最低出价. (如果 for_sale_type 是 域名交易市场, 则必填)
installment (optional)是否允许分期付款。若要启用分期付款,请将其设为 "Yes"
maximum_installments (optional)允许的最大分期期数,仅在 installment 为 "true" 时生效。
你可以选择 2 到 12 之间的数值来表示分期付款的最长月数
category (optional)为您的域名选择一个分类,您可以参考下方的分类与子分类对照表进行选填。
Sub-category (optional)为你的域名选择一个子类别, 你可以参考下方类别与子类别对照表进行选择.
注意: 您的参数值需为子分类对应的数字.
分类子类
advertisingmarketing
retail
sales
automotivecars_trucks
enthusiasts
motorsports
businessinvestment
law
money
professions
services
careers_educationNo subCategory
consumer_goods_servicesapparel
electronics
entertainmentgames
pop_culture
fashionNo subCategory
financeNo subCategory
gamblingcasino
sports
healthfitness
medicine
internetblogs
ecommerce
domains
web_design
web_hosting
otherNo subCategory
placesafrica
asia
europe
north_america
south_america
real_estateNo subCategory
scienceNo subCategory
societyculture
news
politics
religion
sportsleisure_activities
professional
technologycomputers
uncategorizedNo subCategory
adultNo subCategory
homeNo subCategory
aiNo subCategory
aerospaceNo subCategory
agencyNo subCategory
agriculture_companyNo subCategory
analyticsNo subCategory
alcoholNo subCategory
babies_kidsNo subCategory
biotechNo subCategory
clean_energyNo subCategory
cleaningNo subCategory
communityNo subCategory
construction_organizationNo subCategory
cryptocurrency_blockchainNo subCategory
dating_relationshipNo subCategory
daycareNo subCategory
dentalNo subCategory
droneNo subCategory
e_commerceNo subCategory
food_drinkNo subCategory
furnitureNo subCategory
gamesNo subCategory
insuranceNo subCategory
interior_designNo subCategory
legal_lawNo subCategory
motivationalNo subCategory
manufacturingNo subCategory
marketingNo subCategory
medicalNo subCategory
metaverseNo subCategory
movies_tvNo subCategory
music_audioNo subCategory
news_mediaNo subCategory
nftNo subCategory
outdoorNo subCategory
paymentNo subCategory
petsNo subCategory
politicsNo subCategory
property_managementNo subCategory
recruitment_staffingNo subCategory
servicesNo subCategory
securityNo subCategory
socialNo subCategory
transportationNo subCategory
travelNo subCategory
video_books_magazinesNo subCategory
virtual_realityNo subCategory
website_designNo subCategory
Description (optional)您域名的描述
结果 XML 标签
说明
<SetForSaleResponse></SetForSaleResponse>响应的根节点
<SetForSaleHeader></SetForSaleHeader>设置 出售域名 标头
<ResponseCode></ResponseCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置 出售域名 示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<SetForSaleResponse>
  <SetForSaleHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetForSaleHeader>
</SetForSaleResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription
响应 (JSON格式)
{
  "SetForSaleResponse": {
    "ResponseCode: ": "0",
    "Status": "Success"
  }
}
 

转出域名列表命令

支持多线程
支持 API 沙盒

调用“转出域名列表”命令,即可获取正在处理中的转出域名列表。此命令仅支持 XML 和 JSON 格式。如果调用此命令

转出域名列表请求参数
说明
结果 XML 标签
说明
<TransferOutDomainListResponse></TransferOutDomainListResponse>响应的根节点
<TransferOutDomainListHeader></TransferOutDomainListHeader>转出域名列表标题
<ResponseCode></ResponseCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<TransferOutDomainListContent></TransferOutDomainListContent>转出域名列表标题
<TransferOutDomainList></TransferOutDomainList>转出域名列表
<Domain></Domain>该 域名
<OrderId></OrderId>转出域名的订单 ID
<ItemStatus></ItemStatus>域名转出状态

转出域名列表示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=transfer_domain_list
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=transfer_domain_list
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<TransferOutDomainListResponse>
  <TransferOutDomainListHeader>
    <ResponseCode>200</ResponseCode>
    <Status>success</Status>
  </TransferOutDomainListHeader>
  <TransferOutDomainListContent>
    <TransferOutDomainList>
      <TransferOutDomain>
        <OrderId>1</OrderId>
        <Domain>domain1.com</Domain>
        <ItemStatus>Pending</ItemStatus>
      </TransferOutDomain>
    </TransferOutDomainList>
  </TransferOutDomainListContent>
</TransferOutDomainListResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=transfer_domain_list
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=transfer_domain_list
响应 (JSON格式)
{
  "TransferOutDomainListResponse": {
    "ResponseCode": 200,
    "Status": "success",
    "TransferOutDomainList": [
      {
        "orderId": 1,
        "domain": "domain1.com",
        "itemStatus": "Pending"
      }
    ]
  }
}
 

设置 Afternic 确认操作命令

支持多线程
不支持 API 沙盒

调用 Set Afternic 确认操作命令,将在 Afternic 上设置域名以批准或不批准快速转移。此命令仅支持 XML 和 JSON 格式。若调用此命令,应包含以下参数:

设置 Afternic 确认操作请求参数
说明
domain您想要设置 Afternic 确认快速转移操作的域名,每次请求只能输入 1 个域名
action您想把 Afternic 的确认操作设置成什么, 它应为 "confirm_afternic", 或 "delete_from_afternic"
结果 XML 标签
说明
<SetAfternicConfirmActionResponse></SetAfternicConfirmActionResponse>Set Afternic Confirm Action 响应的标签,即响应 XML 文档的根节点。
<SetAfternicConfirmActionHeader></SetAfternicConfirmActionHeader>设置 Afternic 确认操作标头
<ResponseCode></ResponseCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置 Afternic 确认操作示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
沙盒请求 (XML 格式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<SetAfternicConfirmActionResponse>
  <SetAfternicConfirmActionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetAfternicConfirmActionHeader>
</SetAfternicConfirmActionResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
沙盒请求 (JSON格式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
响应 (JSON格式)
{
  "SetAfternicConfirmActionResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

设置 Sedo 确认操作命令

支持多线程
不支持 API 沙盒

调用 Set Sedo Confirm Action 命令,可将域名设置为批准或不批准在 Sedo 上的快速转移。此命令仅支持 XML 和 JSON 格式。调用此命令时,应包含以下参数:

设置 Sedo 确认操作请求参数
说明
domain您要设置 Sedo 确认快速转移操作的域名, 每次请求只能输入 1 个域名
action您想让 Sedo 确认执行的操作,应为 "confirm_sedo" 或 "delete_from_sedo"
结果 XML 标签
说明
<SetSedoConfirmActionResponse></SetSedoConfirmActionResponse>设置 Sedo 确认操作响应的标签,它是响应 XML 文档的根节点
<SetSedoConfirmActionHeader></SetSedoConfirmActionHeader>设置 Sedo 确认操作标头
<ResponseCode></ResponseCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。

设置 Sedo 确认操作示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
沙盒请求 (XML 格式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<SetSedoConfirmActionResponse>
  <SetSedoConfirmActionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetSedoConfirmActionHeader>
</SetSedoConfirmActionResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
沙盒请求 (JSON格式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
响应 (JSON格式)
{
  "SetSedoConfirmActionResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

获取 Whois 统计信息命令

支持多线程
支持 API 沙盒

调用 Get Whois Stats 命令即可获取 whois 统计信息. 该命令仅支持 XML 和 JSON 格式.调用此命令时,应包含以下参数:

获取 Whois 统计信息的请求参数
说明
domain_name您需要为其设置 DNSSEC 的 域名
date_type您可以从下列字段中任选其一,用以表示日期类型:
last_7_days, last_30_days, current_year, last_year
结果 XML 标签
说明
<GetWhoisStatsResponse></GetWhoisStatsResponse>响应的根节点
<GetWhoisStatsHeader></GetWhoisStatsHeader>获取 Whois 统计信息表头
<ResponseCode></ResponseCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<GetWhoisStatsContent></GetWhoisStatsContent>响应内容
<WhoisStats></WhoisStats>包含多组 whois 统计数据
<WhoisStat></WhoisStat>具体的 Whois 统计数据
<Date></Date>最小时间间隔
<Count></Count>当前时间区间内的 whois 数量

获取 Whois 统计信息示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<GetWhoisStatsResponse>
  <GetWhoisStatsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetWhoisStatsHeader>
  <GetWhoisStatsContent>
    <WhoisStats>
      <WhoisStat>
        <Date>2023-11-04</Date>
        <Count>200</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-05</Date>
        <Count>300</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-06</Date>
        <Count>100</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-07</Date>
        <Count>200</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-08</Date>
        <Count>300</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-09</Date>
        <Count>100</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-10</Date>
        <Count>200</Count>
      </WhoisStat>
    </WhoisStats>
  </GetWhoisStatsContent>
</GetWhoisStatsResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
响应 (JSON格式)
{
  "GetWhoisStatsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "WhoisStats": [
      {
        "Date": "2023-11-04",
        "Count": 200
      },
      {
        "Date": "2023-11-05",
        "Count": 300
      },
      {
        "Date": "2023-11-06",
        "Count": 100
      },
      {
        "Date": "2023-11-07",
        "Count": 200
      },
      {
        "Date": "2023-11-08",
        "Count": 300
      },
      {
        "Date": "2023-11-09",
        "Count": 100
      },
      {
        "Date": "2023-11-10",
        "Count": 200
      }
    ]
  }
}
 

订单列表命令

支持多线程
支持 API 沙盒

调用订单列表命令将获取订单列表。此命令仅支持 XML 和 JSON 格式。调用此命令时,需包含以下参数:

订单列表请求参数
说明
search_by您可以从以下列表中选择一个值来代表您的搜索类型: date_range, domain, order_id
start_date查询的开始日期格式为 yyyy/MM/dd
end_date查询的结束日期,格式为 yyyy/MM/dd
payment_method您可以从以下列表中选择多个值来表示您的付款方式:
无余额
账户余额
信用卡
money_order
PayPal
Moneybooker
银行电汇
支付宝
payflow_credit_card2(已不再使用)
微信支付
电子现金
银行_转账
Apple Pay
支票_账户
出售
银联支付
PayPal 账户
mercado_pago
Payoneer
不过,请使用逗号分隔多个值,例如:account_balance,credit_card
结果 XML 标签
说明
<OrderListResponse></OrderListResponse>响应的根节点
<OrderListHeader></OrderListHeader>订单列表表头
<ResponseCode></ResponseCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<OrderListContent></OrderListContent>订单列表表头
<OrderList></OrderList>包含多组 订单记录 数据
<OrderItem></OrderItem>包含单个 订单记录 数据
<OrderItemDomain></OrderItemDomain>包含此订单中各项的 域名
<OrderId></OrderId>包含订单 ID
<SubmittedDate></SubmittedDate>包含订单提交的日期
<Cost></Cost>包含订单费用
<Status></Status>包含订单状态

订单列表示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<OrderListResponse>
  <OrderListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </OrderListHeader>
  <OrderListContent>
    <OrderList>
      <Order>
        <OrderId>123456</OrderId>
        <SubmittedDate>1791875010219</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>1791875010219</SubmittedDate>
        <Currency>EUR</Currency>
        <PaymentMethod>Paypal</PaymentMethod>
        <TotalCost>$100.00</TotalCost>
        <TotalPaid>$100.00</TotalPaid>
        <Status>Submitted</Status>
      </Order>
    </OrderList>
  </OrderListContent>
</OrderListResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card
响应 (JSON格式)
{
  "OrderListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderList": [
      {
        "OrderId": "123456",
        "SubmittedDate": "2026/10/13",
        "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": "2026/10/13",
        "Currency": "EUR",
        "PaymentMethod": "Paypal",
        "TotalCost": "$100.00",
        "TotalPaid": "$100.00",
        "Status": "Submitted",
        "ItemList": []
      }
    ]
  }
}
 

获取订单状态指令

支持多线程
支持 API 沙盒

调用获取订单状态命令即可获取订单状态. 该命令仅支持 XML 和 JSON 格式. 调用此命令时, 应包含以下参数:

获取订单状态请求参数
说明
order_id待查询订单的 ID
结果 XML 标签
说明
<GetOrderStatusResponse></GetOrderStatusResponse>响应的根节点
<GetOrderStatusHeader></GetOrderStatusHeader>获取订单状态标头
<ResponseCode></ResponseCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<GetOrderStatusContent></GetOrderStatusContent>响应内容
<OrderId></OrderId>订单 ID
<OrderStatus></OrderStatus>订单状态( 选购中, 已提交, 待付款, 处理中, 已完成, 异常, 已删除, 已取消 )
<ItemTypeName></ItemTypeName>项目类型
<ItemName></ItemName>拍品名称
<ItemStatus></ItemStatus>项目状态(已完成, 已取消, 有问题)

获取订单状态示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_order_status&order_id=0
沙盒请求 (XML 格式)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_order_status&order_id=0
响应 (XML 格式)
<?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>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_order_status&order_id=0
沙盒请求 (JSON格式)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_order_status&order_id=0
响应 (JSON格式)
{
  "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"
        }
      ]
    }
  }
}
 

正在处理命令

支持多线程
支持 API 沙盒

调用 is_processing 命令,即可知道提交新请求是否安全

Is-Processing 请求参数
说明
无需额外参数
结果 XML 标签
说明
<Response></Response>is_processing 响应的标签
<ResponseHeader></ResponseHeader>is_processing 标头的标签
<ResponseMsg></ResponseMsg>Tag of is_processing response message. It should be "yes"(There is a process in the system. You shouldn't sent another request.) or "no"(There is no any process for you account. It is safe to submit a new request.)

正在处理示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=is_processing
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=is_processing
响应 (XML 格式)
<Response>
  <ResponseHeader>
    <ResponseCode>0</ResponseCode>
    <ResponseMsg>yes</ResponseMsg>
  </ResponseHeader>
</Response>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=is_processing
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=is_processing
响应 (JSON格式)
{
   "Response":{
      "ResponseCode":"0",
      "ResponseMsg":"no"
   }
}
请求 (CSV 格式)https://api.dynadot.com/api3.html?key=[API Key]&command=is_processing
沙盒请求 (CSV 格式)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=is_processing
响应 (CSV 格式)
ok,yes
 

查询优惠券列表命令

支持多线程
支持 API 沙盒

调用 List Coupons 命令将获取所有优惠券。该命令仅支持 XML 和 JSON 格式。调用此命令时,应包含以下参数:

列出优惠券请求参数
说明
coupon_type您可以从以下列表中选择一个值来代表您的搜索类型: "registration" , "renewal" , 或 "transfer"
结果 XML 标签
说明
<ListCouponsResponse></ListCouponsResponse>响应的根节点
<ListCouponsHeader></ListCouponsHeader>列出优惠券请求头
<SuccessCode></SuccessCode>如果操作成功, "0" 表示成功, "-1" 表示失败
<Status></Status>请求状态
<Error></Error>请求相关的错误信息,仅在状态为 "error" 时使用。
<ListCouponsContent></ListCouponsContent>优惠券列表内容
<Coupons></Coupons>包含多组优惠券数据
<Coupon></Coupon>包含单个优惠券数据
<Code></Code>优惠码
<Description></Description>优惠券说明
<CouponType></CouponType>优惠券类型
<DiscountType></DiscountType>优惠券提供的折扣类型
<DiscountInfo></DiscountInfo>优惠券的折扣信息
<Percentage></Percentage>折扣的百分比
<AUD></AUD>以澳元计的折扣金额
<MXN></MXN>以墨西哥比索计的折扣金额
<EUR></EUR>折扣金额(欧元)
<GBP></GBP>以英镑计的折扣金额
<IDR></IDR>以印尼盾计算的折扣金额
<USD></USD>以美元计的折扣金额
<CAD></CAD>以加元计算的折扣金额
<INR></INR>以印度卢比计算的折扣金额
<BRL></BRL>以巴西雷亚尔计的折扣金额
<CNY></CNY>折扣金额(人民币)
<Restriction></Restriction>优惠券限制
<PriceLevels></PriceLevels>一组支持使用优惠券的价格档位
<UsesPerAccount></UsesPerAccount>每个账户可使用优惠券的次数
<UsesSystemWide></UsesSystemWide>该优惠券可在全系统范围内使用的次数
<UsesPerIp></UsesPerIp>每个 IP 地址可使用优惠券的次数
<ItemsPerAccount></ItemsPerAccount>每个账户可使用该优惠券的项目数量
<ItemsSystemWide></ItemsSystemWide>该优惠券可在全系统范围内使用的商品数量
<ItemsPerOrder></ItemsPerOrder>每单优惠券可用的商品数量
<ItemsPerDay></ItemsPerDay>优惠券每日可使用的项目数量
<IdnRestriction></IdnRestriction>优惠券的IDN限制
<DomainDurationMin></DomainDurationMin>域名最短注册期限
<DomainDurationMax></DomainDurationMax>域名最长注册期限
<Tlds></Tlds>支持使用优惠券的一批顶级域名
<Tld></Tld>支持使用优惠券的单个顶级域名
<Currencies></Currencies>支持使用优惠券的货币类型集合
<Currency></Currency>一种支持使用优惠券的单一币种
<StartDate></StartDate>优惠券有效期的起始日期
<EndDate></EndDate>优惠券有效期的截止日期

列出优惠券示例

请求 (XML 格式)https://api.dynadot.com/api3.xml?key=[API Key]&command=list_coupons&coupon_type=renewal
沙盒请求 (XML 格式)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=list_coupons&coupon_type=renewal
响应 (XML 格式)
<?xml version="1.0" encoding="UTF-8"?>
<ListCouponsResponse>
  <ListCouponsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </ListCouponsHeader>
  <ListCouponsContent>
    <Coupons>
      <Coupon>
        <Code>DOMAINRENEW1</Code>
        <Description>Domain Renew Coupon</Description>
        <CouponType>Hosting/SSL Coupons</CouponType>
        <DiscountType>PERCENTAGE_OFF</DiscountType>
        <DiscountInfo>
          <Percentage>10%</Percentage>
        </DiscountInfo>
        <Restriction>
          <PriceLevels>Any</PriceLevels>
          <IdnRestriction>None</IdnRestriction>
          <DomainDurationMin>1</DomainDurationMin>
          <DomainDurationMax>1</DomainDurationMax>
          <Tlds>
            <Tld>.com</Tld>
            <Tld>.net</Tld>
            <Tld>.org</Tld>
          </Tlds>
          <Currencies>
            <Currency>US Dollar USD ($)</Currency>
          </Currencies>
        </Restriction>
        <StartDate>1476811260000</StartDate>
        <EndDate>1483257540000</EndDate>
      </Coupon>
    </Coupons>
  </ListCouponsContent>
</ListCouponsResponse>
请求 (JSON格式)https://api.dynadot.com/api3.json?key=[API Key]&command=list_coupons&coupon_type=renewal
沙盒请求 (JSON格式)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=list_coupons&coupon_type=renewal
响应 (JSON格式)
{
  "ListCouponsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Coupons": [
      {
        "Code": "DOMAINRENEW1",
        "Description": "Domain Renew Coupon",
        "CouponType": "Hosting/SSL Coupons",
        "DiscountType": "PERCENTAGE_OFF",
        "DiscountInfo": {
          "Percentage": "10%"
        },
        "Restriction": {
          "PriceLevels": "Any",
          "IdnRestriction": "None",
          "DomainDurationMin": "1",
          "DomainDurationMax": "1",
          "Tlds": [
            ".com",
            ".net",
            ".org"
          ],
          "Currencies": [
            "US Dollar USD ($)"
          ]
        },
        "StartDate": "1476811260000",
        "EndDate": "1483257540000"
      }
    ]
  }
}