API 说明

API 名称：CreateTemplate

API 域名：domain-openapi.volcengineapi.com

API 描述：创建一个信息模板用以域名注册。

请求方法

POST

使用限制

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

请求鉴权

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

公共参数

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

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

请求参数

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

参数名称	数据类型	必选	参数说明	示例
registration_type	string	是	表示域名所有者的类型。该参数有以下取值： C：表示企业。 P：表示个人。	C
registrant_zh	string	是	该参数的含义如下：如果 registration_type 是 P，该参数表示域名所有者的中文姓名。如果 registration_type 是 C，该参数表示企业的中文名称。该参数可以包含中文汉字、字母和数字，长度在 2 到 128 个字符之间。参数值必须与 id_img 所表示的证件正面照片上的姓名或企业名称相同。	李萌
registrant	string	是	该参数的含义如下：如果 registration_type 是 P，该参数表示域名所有者的英文姓名，可以是中文姓名的拼音。如果 registration_type 是 C，该参数表示企业的英文名称，可以是企业中文名称的拼音。该参数可以包含字母和数字，长度在 2 到 128 个字符之间。	Li Meng
registrant_ln_zh	string	是	表示联系人中文姓名中的姓，必须包含汉字，可以包含字母和数字，长度在 1- 64 个字符之间。	张
registrant_fn_zh	string	是	表示联系人中文姓名中的名，必须包含汉字，可以包含字母和数字，长度在 1- 64 个字符之间。	三
registrant_fn	string	是	表示联系人英文名中的名，可以是中文姓名中名的拼音。该参数必须包含字母，可以包含数字，长度在 1- 64 个字符之间。	san
registrant_ln	string	是	表示联系人英文名中的姓，可以是中文姓名中姓的拼音。该参数必须包含字母，可以包含数字，长度在 1- 64 个字符之间。	zhang
address_zh	string	是	表示联系人的中文地址，必须包含中文，可以包含字母和数字，长度在 2 到 128 个字符之间。建议您输入的地址与您上传的证件图片中的地址相同。注意地址必须包含完整的中国省级行政区名称和城市名称。例如，辽宁省沈阳市是符合要求的，辽宁沈阳不符合要求。如果地址不符合要求，信息模板将无法通过审核。	黑龙江省大庆市萨尔图区拥军大街3-10号5门2室
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
state_zh	string	是	表示 address_zh 中的中国省级行政区。该参数的长度不能超过 64 个字符，必须包含中文汉字。	黑龙江省
state	string	是	表示 state_zh 的拼音。该参数的长度不能超过 64 个字符，必须包含字母。	heilongjiangsheng
city_zh	string	是	表示 address_zh 中的城市。该参数的长度不能超过 64 个字符，必须包含中文汉字。	北京市
country_code	string	否	该参数值必须是 CN，表示中国的国家代码。该参数的默认值也是 CN。	CN
city	string	是	表示 city_zh 的拼音。该参数的长度不能超过 64 个字符，必须包含字母。	beijingshi
tel_number	string	是	表示联系人的电话号码。电话号码只能包含数字，长度不超过 11 个字符。如果 tel_area_code 为空，tel_number 表示联系人的手机号码。如果 tel_area_code 不为空，tel_number 表示联系人的固定电话号码。	12345678912
tel_extension	string	否	表示联系人电话号码的分机号，长度为 1-4 个字符。如果 tel_number 是手机号码，您无需指定该参数。	1234
tel_area_code	string	否	表示联系人电话号码所对应的区号。该参数只能包含数字，长度为 3-4 个字符。如果 tel_number 是手机号码，您无需指定该参数。如果 tel_number 是固定电话号码，您必须指定该参数。注意区号必须匹配 city_zh。
tel_country_code	string	是	表示 tel_number 所对应国家的国家码。当前，该参数只能是 86。86 是中国的国家码。	86
post_code	string	是	表示 address_zh 的邮编。该参数只能包含数字，长度是 6 个字符。	163000
email	string	是	表示联系人的邮箱地址。	aaa@example.com
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	是	表示证件号码。例如身份证号码、营业执照号码等。	310115198404191234
id_img	string	是	表示证件正面照片，以 Base64 编码的字符串。照片格式可以是 JPG/JPEG、PNG、BMP 或者 GIF，文件大小在 55KB 到 5MB 之间。	-

返回参数

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

请求示例

响应示例

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。下表列出了该 API 可能返回的错误码。

错误码	错误信息
81713	请求body过大，不能超过7M，检查下实名证件图片的base64内容是否过大
81400	无效的参数，如参数值类型和api文档要求类型不相符
81801	注册联系人字段中包含无效字符或者过长
81802	注册人地址包含无效字符或者过长
81803	注册联系人失败
81804	注册所有人字段中包含无效字符或者过长
81805	邮箱格式检查异常
81840	邮编格式检查异常
81841	证件类型不在枚举类型中
81842	持有者类型不在枚举类型中
81843	持有者类型和证件类型不匹配
81839	注册所有人(中英文)和注册联系人(中英文)值里面有无效字符
81712	注册所有人(中文)和注册联系人姓名(中文)必须含有中文字符
81711	注册所有人(英文)和注册联系人姓名(英文)不能含有中文字符
81838	固话/手机号信息准确填写不正确, 如号码有无效字符、长度不符合要求
81796	证件号码格式错误
81792	注册所有人证件扫描件格式不符或大小超限，只能上传55KB～5MB的证件
81795	新增的模板和已创建的模板重复，建议修改/删减部分通讯地址文字重试
81722	注册所有人在黑名单
81791	证件号码和证件类型不匹配
81500	网络异常，可以重试

如果该 API 返回的错误码不在该列表中，请参见公共错误码。

域名服务