生成集团加入邀请二维码

1. 接口描述

接口请求域名： ess.tencentcloudapi.com 。

生成集团加入链接，分享至子企业超管或者法人，子企业管理员可通过链接加入集团。注意:调用当前接口的企业必须为集团企业。如何成为集团企业可以参考下面的文档集团操作文档

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateOrganizationGroupInvitationLink。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。使用此接口时，必须填写userId。支持填入集团子公司经办人 userId 代发合同。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
ExpireTime	是	Integer	到期时间（以秒为单位的时间戳），其上限为30天的有效期限。

3. 输出参数

参数名称	类型	描述
Link	String	加入集团二维码链接，子企业的管理员可以直接扫码进入。注意:1. 该链接有效期时间为ExpireTime，同时需要注意保密，不要外泄给无关用户。2. 该链接不支持小程序嵌入，仅支持移动端浏览器打开。3. 生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误）
ExpireTime	Integer	到期时间（以秒为单位的时间戳）
JumpUrl	String	加入集团短链接。注意: 1. 该链接有效期时间为ExpireTime，同时需要注意保密，不要外泄给无关用户。 2. 该链接不支持小程序嵌入，仅支持移动端浏览器打开。 3. 生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误）
MiniAppPath	String	腾讯电子签小程序加入集团链接。小程序和APP集成使用得到的链接类似于`pages/guide?shortKey=yDw***k1xFc5`, 用法可以参考：跳转电子签小程序注：生成的链路后面不能再增加参数
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 生成建工集团集团加入邀请链接

生成建工集团集团加入邀请链接

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateOrganizationGroupInvitationLink
<公共请求参数>

{
    "Operator": {
        "UserId": "yDR4yUUgyg1qh6szUxt1qOK1Jy90khKS",
        "ClientIp": "8.8.8.8"
    },
    "ExpireTime": 1702366386
}

输出示例

{
    "Response": {
        "ExpireTime": 1716683735,
        "JumpUrl": "https://test.essurl.cn/BGgGUBGtln",
        "Link": "https://dyn.test.ess.tencent.cn/imgs/organization/732aaefa78c439d726f541b89c49e022/qrcode/joingroup/yDCZFUUckpyyo8pgUxP8QQ8yRgWF3en4.png",
        "MiniAppPath": "/pages/guide/index?shortKey=yDCZFUyOc8a3FdjP9477",
        "RequestId": "acba9fe30ab0"
    }
}

5. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
ResourceUnavailable	资源不可用。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 生成建工集团集团加入邀请链接​

输入示例​

输出示例​

5. 错误码​