创建企业批量认证链接
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
本接口(CreateBatchOrganizationRegistrationTasks)用于批量创建企业认证链接 该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.
批量创建链接有以下限制:
- 单次最多创建10个企业。
- 一天同一家企业最多创建8000家企业。
- 同一批创建的企业不能重复 其中包括 企业名称,企业统一信用代码
- 跳转到小程序的实现,参考微信官方文档(分为全屏、半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置
注:
- 此接口需要购买单独的实名套餐包方可调用,如有需求请联系对接人员评估
- 如果生成的链接是APP链接,跳转到小程序的实现,参考微信官方文档(分为全屏、半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置
腾讯电子签小程序的AppID 和 原始Id如下:
小程序 | AppID | 原始ID |
---|---|---|
腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateBatchOrganizationRegistrationTasks。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
RegistrationOrganizations.N | 是 | Array of RegistrationOrganizationInfo | 组织机构注册信息。 一次最多支持10条认证流 |
Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 |
Endpoint | 否 | String | 要生成链接的类型, 可以选择的值如下:
示例值:PC |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 生成注册链接的任务Id, 根据这个id, 调用DescribeBatchOrganizationRegistrationUrls 获取生成的链接,进入认证流程 |
ErrorMessages | Array of String | 批量生成企业认证链接的详细错误信息, 顺序与输入参数保持一致。 若企业认证均成功生成,则不返回错误信息; 若存在任何错误,则返回具体的错误描述。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 批量注册三家企业,成功创建任务
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBatchOrganizationRegistrationTasks
<公共请求参数>
{
"Operator": {
"OpenId": "us-768d38720c10405f994539097f030a27",
"UserId": "19561039c99fe825a934a132520fde6a",
"Channel": "YUFU",
"ClientIp": "8.8.8.8"
},
"RegistrationOrganizations": [
{
"OrganizationName": "测试认证企业一",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX1",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
2
]
},
{
"OrganizationName": "测试认证企业二",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX2",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
1
]
},
{
"OrganizationName": "测试认证企业三",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX3",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
2
]
}
]
}
输出示例
{
"Response": {
"TaskId": "abc",
"ErrorMessages": [
""
],
"RequestId": "f38013e59d00"
}
}
示例2 批量注册三家企业,地址不符合格式,返回错误
测试认证企业三的地址没有按照省市区的格式传递
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBatchOrganizationRegistrationTasks
<公共请求参数>
{
"Operator": {
"OpenId": "us-768d38720c10405f994539097f030a27",
"UserId": "19561039c99fe825a934a132520fde6a",
"Channel": "YUFU",
"ClientIp": "8.8.8.8"
},
"RegistrationOrganizations": [
{
"OrganizationName": "测试认证企业一",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX1",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
2
]
},
{
"OrganizationName": "测试认证企业二",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX2",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
1
]
},
{
"OrganizationName": "测试认证企业三",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX3",
"LegalName": "鹅鹅子",
"Address": "测试地址",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
2
]
}
]
}
输出示例
{
"Response": {
"ErrorMessages": [
"",
"第【2】条注册信息参数错误,地址参数不正确,请确认后再试",
""
],
"RequestId": "5cea4b4778bf",
"TaskId": ""
}
}
示例3 批量注册三家企业,企业名称重复,无法创建,返回错误提示
第一家企业和第三家企业名字重复, 无法注册
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBatchOrganizationRegistrationTasks
<公共请求参数>
{
"Operator": {
"OpenId": "us-768d38720c10405f994539097f030a27",
"UserId": "19561039c99fe825a934a132520fde6a",
"Channel": "YUFU",
"ClientIp": "8.8.8.8"
},
"RegistrationOrganizations": [
{
"OrganizationName": "测试认证企业一",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX1",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
2
]
},
{
"OrganizationName": "测试认证企业二",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX2",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
1
]
},
{
"OrganizationName": "测试认证企业一",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX3",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
2
]
}
]
}
输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameterValue",
"Message": "企业名称[测试认证企业一]重复"
},
"RequestId": "4f7b42be805f"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.Decryption | 解密失败。 |
InternalError.DependsApi | 依赖的第三方API返回错误。 |
InternalError.DependsDb | 数据库执行错误。 |
InternalError.Encryption | 加密失败。 |
InternalError.System | 系统错误,请稍后重试。 |
InvalidParameter.ParamError | 参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.Forbid | 禁止此项操作。 |
OperationDenied.NoLogin | 用户未登录,请先登录后再操作。 |
OperationDenied.SubOrgNotJoin | 子企业暂未加入。 |