跳到主要内容

创建企业批量认证链接

1. 接口描述

接口请求域名: essbasic.tencentcloudapi.com 。

本接口(CreateBatchOrganizationRegistrationTasks)用于批量创建企业认证链接 该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.

批量创建链接有以下限制:

  1. 单次最多创建10个子客。
  2. 一天同一家企业最多创建8000个子客。
  3. 同一批创建的子客不能重复 其中包括 企业名称,企业统一信用代码,子客经办人openId。
  4. 跳转到小程序的实现,参考微信官方文档(分为全屏、半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置

注: 1. 如果生成的链接是APP链接,跳转到小程序的实现,参考微信官方文档(分为全屏半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置

腾讯电子签小程序的AppID 和 原始Id如下:

小程序AppID原始ID
腾讯电子签(正式版)wxa023b292fd19d41dgh_da88f6188665
腾讯电子签Demowx371151823f6f3edfgh_39a5d3de69fa

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称必选类型描述
ActionString公共参数,本接口取值:CreateBatchOrganizationRegistrationTasks。
VersionString公共参数,本接口取值:2021-05-26。
RegionString公共参数,此参数为可选参数。
AgentAgent关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId


第三方平台子客企业和员工必须已经经过实名认证
RegistrationOrganizations.NArray of RegistrationOrganizationInfo当前应用下子客的组织机构注册信息。
一次最多支持10条认证流
EndpointString生成链接的类型:
  • PC:(默认)web控制台链接, 需要在PC浏览器中打开
  • CHANNEL:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
  • SHORT_URL:H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
  • APP:第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序
  • H5:第三方H5跳转到电子签H5长链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面
  • SHORT_H5:第三方H5跳转到电子签H5短链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面

示例值:PC

示例值:PC

3. 输出参数

参数名称类型描述
TaskIdString生成注册链接的任务Id,
根据这个id, 调用DescribeBatchOrganizationRegistrationUrls 获取生成的链接,进入认证流程
若存在其中任意一条链接错误,则返回具体的错误描述, 不会返回TaskId
ErrorMessagesArray of String批量生成企业认证链接的详细错误信息,
顺序与输入参数保持一致。
若企业认证均成功生成,则不返回错误信息;
若存在任何错误,则返回具体的错误描述。
RequestIdString唯一请求 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请升级到对应版本后即可使用该接口。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062