You need to enable JavaScript to run this app.
导航
创建信息模板
最近更新时间:2024.01.30 20:17:28首次发布时间:2023.05.22 22:30:38

API 说明

API 名称:CreateTemplate
API 域名:open.volcengineapi.com
API 描述:创建一个信息模板用以域名注册。

请求方法

POST

使用限制

节流限制:您每秒最多可以提交 20 个请求。

请求鉴权

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见请求鉴权

公共参数

在调用该 API 时,您在请求中必须包含公共参数。在这些公共参数中,以下两个查询参数的取值说明如下:

参数名称数据类型必选参数说明
Actionstring表示 API 的名称。该参数的取值是 CreateTemplate
Versionstring表示 API 的版本。该参数的取值是 2022-12-12

请求参数

该 API 的请求参数的类型是请求正文参数。

参数名称数据类型必选参数说明示例

registration_type

string

表示域名所有者的类型。该参数有以下取值:

  • C:表示企业。

  • P:表示个人。

C

post_codestring表示域名所有者地址的邮编。该参数只能包含数字,长度是 6 个字符。163000
emailstring表示域名所有者的邮箱。aaa@example.com

registrant

string

表示域名所有者的英文名。英文名可以包含字母和数字,并且至少包含一个字母。英文名的长度在 2-64 个字符之间。

该英文名是 id_type 所指示的证件上的中文名所对应的。

Li Meng

registrant_fnstring表示联系人的英文姓名中的名,只能包含字母和数字,并且至少包含一个字母。Meng

registrant_ln

string

表示联系人的英文姓名中的姓,只能包含字母和数字,并且至少包含一个字母。

Li

address

string

表示域名所有者的英文地址。英文地址至少包含一个字母,长度不能超过 128 个字符。

Hei Long Jiang Sheng Da Qing Shi Sa Er Tu Qu Yong Jun Da Jie 3-10 Hao 5 Men 2 Shi

citystring表示域名所有者所在的城市的英文名称。城市的英文名称至少包含一个字母,长度不能超过 64 个字符。beijingshi
statestring表示域名所有者所在的省份的英文名称。省份的英文名称至少包含一个字母,长度不能超过 64 个字符。heilongjiangsheng

registrant_zh

string

表示域名所有者的中文名,可以包含字母、数字和中文汉字,并且至少包含一个中文汉字。中文名的长度在 2 到 64 个字符之间。

该中文名是 id_type 所指示的证件上的。

李萌

registrant_fn_zhstring表示联系人中文姓名中的名。名可以包含字母、数字和中文汉字,并且至少包含一个中文汉字。
registrant_ln_zhstring表示联系人中文姓名的姓。姓可以包含字母、数字和中文汉字,并且至少包含一个中文汉字。

address_zh

string

表示域名所有者的中文地址。地址可以包含字母、数字和中文汉字,并且至少包含一个中文汉字。地址长度不能超过 128 个字符。

注意

地址必须包含完整的省份名称和城市名称。例如:辽宁省沈阳市 不能写成 辽宁沈阳,否则模板将审核失败。

黑龙江省大庆市萨尔图区拥军大街3-10号5门2室

city_zh

string

表示域名所有者的中文城市。城市可以包含字母、数字和中文汉字,并且至少包含一个中文汉字。城市长度不能超过 64 个字符。

北京市

state_zhstring表示域名所有者的中文省份。省份可以包含字母、数字和中文汉字,并且至少包含一个中文汉字。省份长度不能超过 64 个字符。黑龙江省
tel_country_codestring表示联系人电话号码中的国家码。当前,国家码只能是 86。86 表示中国的国家码。86

tel_area_code

string

表示联系人电话号码中的区号。该参数的说明如下:

  • 如果 tel_number 表示的是一个座机号码,该参数为必填。该参数只能包含数字,长度为 3 个或 4 个字符。

  • 如果 tel_number 表示的是一个手机号码,您无需填写该参数。

注意

区号必须匹配 address_zh 中的地区。

tel_number

string

表示联系人电话号码。电话号码只能包含数字,长度不超过 11 个字符。

手机号码的长度是 11 位数字,座机号码的长度是 7-8 位数字。

12345678912

tel_extension

string

表示联系人电话号码的分机。该参数的说明如下:

  • 如果 tel_number 表示的是一个座机号码,该参数是可选的。该参数只能包含数字,长度为 1-4 个字符。

  • 如果 tel_number 表示的是一个手机号码,您无需填写该参数。

1234

id_type

string

表示域名所有者提供的证件的类型。证件类型是在"个人"与"企业"这 2 个大类下。该参数有以下取值:

个人

  • SFZ:表示身份证。

  • HZ:表示护照。

  • TXZ:表示港澳居民来往内地通行证。

  • TWSFZ:台湾居民来往大陆通行证。

  • GWSFZ:表示外国人永久居留身份证。

  • GAJZZ:表示港澳居民居住证。

  • TWJZZ:表示台湾居民居住证。

企业

  • ORG:表示组织机构代码证。

  • YYZZ:表示工商营业执照。

  • TYDMZ:表示统一社会信用代码证书。

  • BDDH:表示部队代号。

  • JDXKZ:表示军队单位对外有偿服务许可证。

  • SYZS:表示事业单位法人证书。

  • GWCZDJZ:表示外国企业常驻代表机构登记。

  • STDJZ:表示社会团体法人登记证书。

  • ZJDJZ:表示宗教活动场所登记证。

  • MBDJZ:表示民办非企业单位登记证书。

  • JJDJZ:表示基金会法人登记证书。

  • LSXKZ:表示律师事务所执业许可证。

  • GWZHDJZ:表示外国在华文化中心登记证。

  • GWLYDJZ:表示外国政府旅游部门常驻代表机构批准登记证。

  • SFXKZ:表示司法鉴定许可证。

  • GWJGZJ:表示外国机构证件。

  • SHFWJGZ:表示社会服务机构登记证书。

  • MBXXXKZ:表示民办学校办学许可证。

  • YLJGXKZ:表示医疗机构执业许可证。

  • GZJGZYZ:表示公证机构执业证。

  • BJWSXX:表示北京市外国驻华使馆人员子女学校办学许可证。

  • QTTYDMZ:表示其他统一社会信用代码证书。

如果您需要在模板创建后对模板启动实名认证流程,该参数必填。

SFZ

id_code

string

表示 id_type 所指示的证件的号码。例如身份证号码、营业执照号码等。

如果您需要在模板创建后对模板启动实名认证流程,该参数必填。

310115198404191234

id_img

string

表示证件的正面照片转换成的Base64字符串。该照片必须为 JPG 或 JPEG 格式,文件大小在 55KB 与 1MB 之间。

如果您需要在模板创建后对模板启动实名认证流程,该参数必填。

响应正文

参数名称数据类型参数说明示例
tagstring表示创建后的模板的 tag。G0zM6RUUWLPysIuVPF7obA==

示例

请求示例

POST https://open.volcengineapi.com?Version=2022-12-12&Action=CreateTemplate
{
    "registration_type":"P",
    "post_code":"163000",
    "email": "aaa@example.com",
    "registrant":"San Zhang",
    "registrant_fn":"San",
    "registrant_ln":"Zhang",
    "address":"My Address",
    "city":"Shanghai",
    "state":"Shanghai",
    "registrant_zh": "张三",
    "registrant_fn_zh":"三",
    "registrant_ln_zh":"李",
    "address_zh":"我的地址",
    "city_zh": "上海",
    "state_zh": "上海",
    "tel_country_code": "86",
    "tel_number":"12345678963"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230522152902BF8AE46450333517309F",
        "Action": "CreateTemplate",
        "Version": "2022-12-12",
        "Service": "domain_openapi",
        "Region": "cn-north-1"
    },
    "Result": {
        "tag": "G0zM6RUUWLPysIuVPF7obA=="
    }
}

错误码

如果响应正文包含 Error 字段,则表示 API 请求失败。关于更多错误码的信息,参见 错误码