提交子企业批量认证链接创建任务
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
该接口用于批量创建企业认证链接, 可以支持PC浏览器,H5和小程序三种途径。 此接口为异步提交任务接口,需要与查询子企业批量认证链接配合使用,整体流程如下图。
注意
- 单次最多创建10个子企业。
- 一天内,同一家企业最多创建8000个子企业。
- 同一批创建的子客户不能重复,包括企业名称、企业统一信用代码和子客户经办人openId。
- 跳转到小程序的实现,请参考微信官方文档(分为全屏、半屏两种方式)。如何配置跳转电子签小程序,可参考:跳转电子签小程序配置。
腾讯电子签小程序的AppID 和 原始Id如下:
小程序 | AppID | 原始ID |
---|---|---|
腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateBatchOrganizationRegistrationTasks。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
|
RegistrationOrganizations.N | 是 | Array of RegistrationOrganizationInfo | 当前应用下子企业的组织机构注册信息。最多支持查询10子企业。 |
Endpoint | 否 | String | 生成链接的类型:
示例值:PC |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 生成注册链接的任务ID,后序根据这个任务ID, 调用查询子企业批量认证链接获取生成的链接,发给对应的客户使用。 注: 如果有错误,则不会返回任务ID |
ErrorMessages | Array of String | 批量生成企业认证链接的详细错误信息,顺序与输入参数子企业列表顺序一致。
|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 批量生成企业注册链接成功
用户同时创建3个企业, 创建链接成功
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBatchOrganizationRegistrationTasks
<公共请求参数>
{
"Agent": {
"ProxyOperator": {
"OpenId": "ceshi"
},
"ProxyOrganizationOpenId": "ceshi_org",
"AppId": "60e16350b0361c888ecb30477d2c16e9"
},
"RegistrationOrganizations": [
{
"OrganizationName": "测试认证企业一",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX1",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
1
],
"OrganizationOpenId": "1",
"OpenId": "1"
},
{
"OrganizationName": "测试认证企业二",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX2",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
1
],
"OrganizationOpenId": "2",
"OpenId": "2"
},
{
"OrganizationName": "测试认证企业三",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX3",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
2
],
"OrganizationOpenId": "3",
"OpenId": "3"
}
]
}
输出示例
{
"Response": {
"ErrorMessages": [],
"RequestId": "f38013e59d00",
"TaskId": "yDRBJUUgygqwl721UuO4zjECcJHV2RAi"
}
}
示例2 批量注册三家企业,地址不符合格式,返回错误
测试认证企业三的地址没有按照省市区的格式传递
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBatchOrganizationRegistrationTasks
<公共请求参数>
{
"Agent": {
"ProxyOperator": {
"OpenId": "ceshi"
},
"ProxyOrganizationOpenId": "ceshi_org",
"AppId": "60e16350b0361c888ecb30477d2c16e9"
},
"RegistrationOrganizations": [
{
"OrganizationName": "测试认证企业一",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX1",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
1
],
"OrganizationOpenId": "1",
"OpenId": "1"
},
{
"OrganizationName": "测试认证企业二",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX2",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
1
],
"OrganizationOpenId": "2",
"OpenId": "2"
},
{
"OrganizationName": "测试认证企业三",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX3",
"LegalName": "鹅鹅子",
"Address": "1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
1
],
"OrganizationOpenId": "3",
"OpenId": "3"
}
]
}
输出示例
{
"Response": {
"ErrorMessages": [
"",
"",
"第【3】条注册信息参数错误,地址参数不正确,请确认后再试"
],
"RequestId": "5cea4b4778bf",
"TaskId": ""
}
}
示例3 批量注册三家企业,企业名称重复,无法创建,返回错误提示
第一家企业和第三家企业名字重复, 无法注册
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBatchOrganizationRegistrationTasks
<公共请求参数>
{
"Agent": {
"ProxyOperator": {
"OpenId": "ceshi"
},
"ProxyOrganizationOpenId": "ceshi_org",
"AppId": "60e16350b0361c888ecb30477d2c16e9"
},
"RegistrationOrganizations": [
{
"OrganizationName": "测试认证企业一",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX1",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
1
],
"OrganizationOpenId": "1",
"OpenId": "1"
},
{
"OrganizationName": "测试认证企业二",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX2",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
1
],
"OrganizationOpenId": "2",
"OpenId": "2"
},
{
"OrganizationName": "测试认证企业一",
"UniformSocialCreditCode": "9XXXXXXXXXXXXXXXX3",
"LegalName": "鹅鹅子",
"Address": "深圳市南山区1000号腾讯大厦",
"AdminName": "鹅鹅子",
"AdminMobile": "187XXXXXXX0",
"AuthorizationTypes": [
1
],
"OrganizationOpenId": "3",
"OpenId": "3"
}
]
}
输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameterValue",
"Message": "企业名称[测试认证企业一]重复"
},
"RequestId": "4f7b42be805f"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.NoRoleAuth | 无角色授权,请确认数据是否存在 |
InternalError.DbRead | 数据库读取失败。 |
InvalidParameter.ParamError | 参数错误。 |
OperationDenied | 操作被拒绝。 |
ResourceNotFound.Application | 应用号不存在。 |
ResourceNotFound.Flow | 未找到对应流程。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |