激活或者续期子企业
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
激活或续期子客企业, 在激活状态下,企业可以正常发起合同;在非激活状态下,企业仅能查看和签署合同。
1. 激活:使用一个许可证将子客企业从未激活状态转变为激活状态。激活状态的有效期为一年,一年后将自动回到未激活状态。
2. 续期:使用一个许可证将已激活的子客企业的有效期延长一年。只有处于激活状态的子企业才能进行续期操作(若处于非激活状态,则需先激活)。您可以使用多个许可证对同一子客企业进行多次续费。
该接口的效果同:【企业应用管理】 -> 【子客企业管理】 -> 【激活】或者【续期】
如果不想调用此接口或者页面点击进行激活或续期,可以在【应用扩展服务】中打开自动激活或续期,在许可证充足的情况下会自动激活或续期子客企业
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateChannelSubOrganizationActive。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
第三方平台子客企业和员工必须已经经过实名认证 |
SubOrganizationOpenIds.N | 否 | Array of String | 要进行激活或者续期的子客企业OrganizationOpenId列表,请确保所有列出的子客企业均已完成认证。 |
Renew | 否 | Boolean | 操作类型,可以选择如下: false:(默认)激活子客企业 true:续期子客企业 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 子客续期
org_zhangsan和org_lisi两个企业已经是激活态,现在花费两个许可证给两个子客企业分别再续期1年
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateChannelSubOrganizationActive
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
}
},
"SubOrganizationOpenIds": [
"org_zhangsan",
"org_lisi"
],
"Renew": true
}
输出示例
{
"Response": {
"RequestId": "00f08f1c-3823-44c3-8cd1-4e66a0587ab4"
}
}
示例2 子客激活
org_zhangsan和org_lisi两个企业现在是非激活态(可能是过期,也可能是没有激活过),现在花费两个许可证激活这两个子客企业
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateChannelSubOrganizationActive
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
}
},
"SubOrganizationOpenIds": [
"org_zhangsan",
"org_lisi"
]
}
输出示例
{
"Response": {
"RequestId": "00f08f1c-3823-44c3-8cd1-4e66a0587ab4"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ParamError | 参数错误。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
ResourceNotFound.Application | 应用号不存在。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |