com.tencentcloudapi.essbasic.v20210526.models

Class CreateConsoleLoginUrlRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.essbasic.v20210526.models.CreateConsoleLoginUrlRequest

public class CreateConsoleLoginUrlRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateConsoleLoginUrlRequest()
CreateConsoleLoginUrlRequest(CreateConsoleLoginUrlRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Module传值 ModuleId传值 进入的目标页面 SEAL 印章ID 查看指定印章的详情页面 TEMPLATE 合同模板ID 指定模板的详情页面 DOCUMENT 合同ID 指定合同的详情页面 注意：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。 Module传值 ModuleId传值 进入的目标页面 SEAL 印章ID 查看指定印章的详情页面 TEMPLATE 合同模板ID 指定模板的详情页面 DOCUMENT 合同ID 指定合同的详情页面 注意：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。

Modifier and Type	Method and Description
Agent	getAgent() Get 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 注: `1.
Long[]	getAuthorizationTypes() Get 可选的此企业允许的授权方式, 可以设置的方式有: 1：上传授权书 2：转法定代表人授权 4：企业实名认证（信任第三方认证源）（此项有排他性, 选择后不能增添其他的方式） 注: 未选择信任第三方认证源时，如果是法人进行企业激活，仅支持法人扫脸直接授权，该配置不对此法人生效` 选择信任第三方认证源时，请先通过同步企业信息接口同步信息。 该参数仅在企业未激活时生效
Boolean	getAutoActive() Get 是否自动激活子客
String	getAutoJumpBackEvent() Get 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括： **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序
String	getAutoJumpUrl() Get 认证完成跳转链接。 注意：`此功能仅在Endpoint参数设置成 H5 或 PC时才有效`。
String	getEndpoint() Get 生成链接的类型： **PC**：(默认)web控制台链接, 需要在PC浏览器中打开 **CHANNEL**：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序 **SHORT_URL**：H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序 **APP**：APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序 **H5**：H5长链接跳转H5链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面 **SHORT_H5**：H5短链跳转H5的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签H5页面
String	getMenuStatus() Get 是否展示左侧菜单栏 **ENABLE** : (默认)进入web控制台展示左侧菜单栏 **DISABLE** : 进入web控制台不展示左侧菜单栏 注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。
String	getModule() Get Web控制台登录后进入的功能模块, 支持的模块包括： **空值** :(默认)企业中心模块 **DOCUMENT** :合同管理模块 **TEMPLATE** :企业模板管理模块 **SEAL** :印章管理模块 **OPERATOR** :组织管理模块 注意： 1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块 2、该参数**仅在企业和员工激活已经完成，登录控制台场景才生效**。
String	getModuleId() Get 该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。 根据Module参数的不同所代表的含义不同(ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到)。当前支持：
UserInfo	getOperator() Deprecated.
String	getProxyOperatorIdCardNumber() Get 子客经办人身份证 注意：`如果已同步，这里非空会更新同步的经办人身份证号，暂时只支持居民身份证类型`。
String	getProxyOperatorMobile() Get 子客企业员工的手机码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。注：`该手机号需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该手机号会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人手机号传入将不会生效`
String	getProxyOperatorName() Get 子客企业员工的姓名，最大长度50个字符, 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 注：`该姓名需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人名字传入将不会生效`
String	getProxyOrganizationName() Get 第三方平台子客的企业名称，请确认该企业名称与企业营业执照中注册的名称完全一致。 在测试环境联调的过程中，企业名称请统一加上“测试”二字，如：典子谦示例企业测试，否则将无法审核通过。 企业名称请使用以下名称, 以下名称可以不用走收录。 子客测试专用企业1 - 子客测试专用企业9** 注: `1.
String	getTopNavigationStatus() Get 是否展示头顶导航栏 **ENABLE** : (默认)进入web控制台展示头顶导航栏 **DISABLE** : 进入web控制台不展示头顶导航栏 注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。 点击查看头顶导航栏位置
String	getUniformSocialCreditCode() Get 子客企业统一社会信用代码，最大长度200个字符 注意：`如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效`。
void	setAgent(Agent Agent) Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 注: `1.
void	setAuthorizationTypes(Long[] AuthorizationTypes) Set 可选的此企业允许的授权方式, 可以设置的方式有: 1：上传授权书 2：转法定代表人授权 4：企业实名认证（信任第三方认证源）（此项有排他性, 选择后不能增添其他的方式） 注: 未选择信任第三方认证源时，如果是法人进行企业激活，仅支持法人扫脸直接授权，该配置不对此法人生效` 选择信任第三方认证源时，请先通过同步企业信息接口同步信息。 该参数仅在企业未激活时生效
void	setAutoActive(Boolean AutoActive) Set 是否自动激活子客
void	setAutoJumpBackEvent(String AutoJumpBackEvent) Set 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括： **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序
void	setAutoJumpUrl(String AutoJumpUrl) Set 认证完成跳转链接。 注意：`此功能仅在Endpoint参数设置成 H5 或 PC时才有效`。
void	setEndpoint(String Endpoint) Set 生成链接的类型： **PC**：(默认)web控制台链接, 需要在PC浏览器中打开 **CHANNEL**：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序 **SHORT_URL**：H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序 **APP**：APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序 **H5**：H5长链接跳转H5链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面 **SHORT_H5**：H5短链跳转H5的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签H5页面
void	setMenuStatus(String MenuStatus) Set 是否展示左侧菜单栏 **ENABLE** : (默认)进入web控制台展示左侧菜单栏 **DISABLE** : 进入web控制台不展示左侧菜单栏 注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。
void	setModule(String Module) Set Web控制台登录后进入的功能模块, 支持的模块包括： **空值** :(默认)企业中心模块 **DOCUMENT** :合同管理模块 **TEMPLATE** :企业模板管理模块 **SEAL** :印章管理模块 **OPERATOR** :组织管理模块 注意： 1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块 2、该参数**仅在企业和员工激活已经完成，登录控制台场景才生效**。
void	setModuleId(String ModuleId) Set 该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。 根据Module参数的不同所代表的含义不同(ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到)。当前支持：
void	setOperator(UserInfo Operator) Deprecated.
void	setProxyOperatorIdCardNumber(String ProxyOperatorIdCardNumber) Set 子客经办人身份证 注意：`如果已同步，这里非空会更新同步的经办人身份证号，暂时只支持居民身份证类型`。
void	setProxyOperatorMobile(String ProxyOperatorMobile) Set 子客企业员工的手机码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。注：`该手机号需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该手机号会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人手机号传入将不会生效`
void	setProxyOperatorName(String ProxyOperatorName) Set 子客企业员工的姓名，最大长度50个字符, 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 注：`该姓名需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人名字传入将不会生效`
void	setProxyOrganizationName(String ProxyOrganizationName) Set 第三方平台子客的企业名称，请确认该企业名称与企业营业执照中注册的名称完全一致。 在测试环境联调的过程中，企业名称请统一加上“测试”二字，如：典子谦示例企业测试，否则将无法审核通过。 企业名称请使用以下名称, 以下名称可以不用走收录。 子客测试专用企业1 - 子客测试专用企业9** 注: `1.
void	setTopNavigationStatus(String TopNavigationStatus) Set 是否展示头顶导航栏 **ENABLE** : (默认)进入web控制台展示头顶导航栏 **DISABLE** : 进入web控制台不展示头顶导航栏 注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。 点击查看头顶导航栏位置
void	setUniformSocialCreditCode(String UniformSocialCreditCode) Set 子客企业统一社会信用代码，最大长度200个字符 注意：`如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效`。
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateConsoleLoginUrlRequest

public CreateConsoleLoginUrlRequest()

CreateConsoleLoginUrlRequest

public CreateConsoleLoginUrlRequest(CreateConsoleLoginUrlRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getAgent

public Agent getAgent()

Get 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容 此接口下面信息必填。

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

注: `1. 企业激活时， 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识，建议开发者保存企业ProxyOrganizationOpenId，后续各项接口调用皆需要此参数。 ` `2. 员工认证时， 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识，建议开发者保存此员工的OpenId，后续各项接口调用皆需要此参数。 ` `3. 同渠道应用(Agent.AppId)下，企业唯一标识ProxyOrganizationOpenId需要保持唯一，员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `

Returns:

Agent 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容 此接口下面信息必填。

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

注: `1. 企业激活时， 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识，建议开发者保存企业ProxyOrganizationOpenId，后续各项接口调用皆需要此参数。 ` `2. 员工认证时， 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识，建议开发者保存此员工的OpenId，后续各项接口调用皆需要此参数。 ` `3. 同渠道应用(Agent.AppId)下，企业唯一标识ProxyOrganizationOpenId需要保持唯一，员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `

setAgent

public void setAgent(Agent Agent)

Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容 此接口下面信息必填。

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

注: `1. 企业激活时， 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识，建议开发者保存企业ProxyOrganizationOpenId，后续各项接口调用皆需要此参数。 ` `2. 员工认证时， 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识，建议开发者保存此员工的OpenId，后续各项接口调用皆需要此参数。 ` `3. 同渠道应用(Agent.AppId)下，企业唯一标识ProxyOrganizationOpenId需要保持唯一，员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `

Parameters:

Agent - 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容 此接口下面信息必填。

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

注: `1. 企业激活时， 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识，建议开发者保存企业ProxyOrganizationOpenId，后续各项接口调用皆需要此参数。 ` `2. 员工认证时， 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识，建议开发者保存此员工的OpenId，后续各项接口调用皆需要此参数。 ` `3. 同渠道应用(Agent.AppId)下，企业唯一标识ProxyOrganizationOpenId需要保持唯一，员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `

getProxyOrganizationName

public String getProxyOrganizationName()

Get 第三方平台子客的企业名称，请确认该企业名称与企业营业执照中注册的名称完全一致。 在测试环境联调的过程中，企业名称请统一加上“测试”二字，如：典子谦示例企业测试，否则将无法审核通过。 企业名称请使用以下名称, 以下名称可以不用走收录。 子客测试专用企业1 - 子客测试专用企业9** 注: `1. 如果名称中包含英文括号()，请使用中文括号（）代替。` `2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。 `

Returns:

ProxyOrganizationName 第三方平台子客的企业名称，请确认该企业名称与企业营业执照中注册的名称完全一致。 在测试环境联调的过程中，企业名称请统一加上“测试”二字，如：典子谦示例企业测试，否则将无法审核通过。 企业名称请使用以下名称, 以下名称可以不用走收录。 子客测试专用企业1 - 子客测试专用企业9** 注: `1. 如果名称中包含英文括号()，请使用中文括号（）代替。` `2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。 `

setProxyOrganizationName

public void setProxyOrganizationName(String ProxyOrganizationName)

Set 第三方平台子客的企业名称，请确认该企业名称与企业营业执照中注册的名称完全一致。 在测试环境联调的过程中，企业名称请统一加上“测试”二字，如：典子谦示例企业测试，否则将无法审核通过。 企业名称请使用以下名称, 以下名称可以不用走收录。 子客测试专用企业1 - 子客测试专用企业9** 注: `1. 如果名称中包含英文括号()，请使用中文括号（）代替。` `2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。 `

Parameters:

ProxyOrganizationName - 第三方平台子客的企业名称，请确认该企业名称与企业营业执照中注册的名称完全一致。 在测试环境联调的过程中，企业名称请统一加上“测试”二字，如：典子谦示例企业测试，否则将无法审核通过。 企业名称请使用以下名称, 以下名称可以不用走收录。 子客测试专用企业1 - 子客测试专用企业9** 注: `1. 如果名称中包含英文括号()，请使用中文括号（）代替。` `2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。 `

getUniformSocialCreditCode

public String getUniformSocialCreditCode()

Get 子客企业统一社会信用代码，最大长度200个字符 注意：`如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效`。

Returns:

UniformSocialCreditCode 子客企业统一社会信用代码，最大长度200个字符 注意：`如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效`。

setUniformSocialCreditCode

public void setUniformSocialCreditCode(String UniformSocialCreditCode)

Set 子客企业统一社会信用代码，最大长度200个字符 注意：`如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效`。

Parameters:

UniformSocialCreditCode - 子客企业统一社会信用代码，最大长度200个字符 注意：`如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效`。

getProxyOperatorName

public String getProxyOperatorName()

Get 子客企业员工的姓名，最大长度50个字符, 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 注：`该姓名需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人名字传入将不会生效`

Returns:

ProxyOperatorName 子客企业员工的姓名，最大长度50个字符, 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 注：`该姓名需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人名字传入将不会生效`

setProxyOperatorName

public void setProxyOperatorName(String ProxyOperatorName)

Set 子客企业员工的姓名，最大长度50个字符, 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 注：`该姓名需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人名字传入将不会生效`

Parameters:

ProxyOperatorName - 子客企业员工的姓名，最大长度50个字符, 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 注：`该姓名需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人名字传入将不会生效`

getProxyOperatorMobile

public String getProxyOperatorMobile()

Get 子客企业员工的手机码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。注：`该手机号需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该手机号会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人手机号传入将不会生效`

Returns:

ProxyOperatorMobile 子客企业员工的手机码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。注：`该手机号需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该手机号会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人手机号传入将不会生效`

setProxyOperatorMobile

public void setProxyOperatorMobile(String ProxyOperatorMobile)

Set 子客企业员工的手机码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。注：`该手机号需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该手机号会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人手机号传入将不会生效`

Parameters:

ProxyOperatorMobile - 子客企业员工的手机码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。注：`该手机号需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该手机号会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人手机号传入将不会生效`

getModule

public String getModule()

Get Web控制台登录后进入的功能模块, 支持的模块包括：

• **空值** :(默认)企业中心模块
• **DOCUMENT** :合同管理模块
• **TEMPLATE** :企业模板管理模块
• **SEAL** :印章管理模块
• **OPERATOR** :组织管理模块

注意： 1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块 2、该参数**仅在企业和员工激活已经完成，登录控制台场景才生效**。

Returns:

Module Web控制台登录后进入的功能模块, 支持的模块包括：

• **空值** :(默认)企业中心模块
• **DOCUMENT** :合同管理模块
• **TEMPLATE** :企业模板管理模块
• **SEAL** :印章管理模块
• **OPERATOR** :组织管理模块

注意： 1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块 2、该参数**仅在企业和员工激活已经完成，登录控制台场景才生效**。

setModule

public void setModule(String Module)

Set Web控制台登录后进入的功能模块, 支持的模块包括：

• **空值** :(默认)企业中心模块
• **DOCUMENT** :合同管理模块
• **TEMPLATE** :企业模板管理模块
• **SEAL** :印章管理模块
• **OPERATOR** :组织管理模块

注意： 1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块 2、该参数**仅在企业和员工激活已经完成，登录控制台场景才生效**。

Parameters:

Module - Web控制台登录后进入的功能模块, 支持的模块包括：

• **空值** :(默认)企业中心模块
• **DOCUMENT** :合同管理模块
• **TEMPLATE** :企业模板管理模块
• **SEAL** :印章管理模块
• **OPERATOR** :组织管理模块

注意： 1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块 2、该参数**仅在企业和员工激活已经完成，登录控制台场景才生效**。

getModuleId

public String getModuleId()

Get 该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。 根据Module参数的不同所代表的含义不同(ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到)。当前支持：

Module传值	ModuleId传值	进入的目标页面
SEAL	印章ID	查看指定印章的详情页面
TEMPLATE	合同模板ID	指定模板的详情页面
DOCUMENT	合同ID	指定合同的详情页面

注意：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。

Returns:

ModuleId 该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。 根据Module参数的不同所代表的含义不同(ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到)。当前支持：

Module传值	ModuleId传值	进入的目标页面
SEAL	印章ID	查看指定印章的详情页面
TEMPLATE	合同模板ID	指定模板的详情页面
DOCUMENT	合同ID	指定合同的详情页面

注意：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。

setModuleId

public void setModuleId(String ModuleId)

Set 该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。 根据Module参数的不同所代表的含义不同(ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到)。当前支持：

Module传值	ModuleId传值	进入的目标页面
SEAL	印章ID	查看指定印章的详情页面
TEMPLATE	合同模板ID	指定模板的详情页面
DOCUMENT	合同ID	指定合同的详情页面

注意：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。

Parameters:

ModuleId - 该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。 根据Module参数的不同所代表的含义不同(ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到)。当前支持：

Module传值	ModuleId传值	进入的目标页面
SEAL	印章ID	查看指定印章的详情页面
TEMPLATE	合同模板ID	指定模板的详情页面
DOCUMENT	合同ID	指定合同的详情页面

注意：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。

getMenuStatus

public String getMenuStatus()

Get 是否展示左侧菜单栏

• **ENABLE** : (默认)进入web控制台展示左侧菜单栏
• **DISABLE** : 进入web控制台不展示左侧菜单栏

注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。

Returns:

MenuStatus 是否展示左侧菜单栏

• **ENABLE** : (默认)进入web控制台展示左侧菜单栏
• **DISABLE** : 进入web控制台不展示左侧菜单栏

注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。

setMenuStatus

public void setMenuStatus(String MenuStatus)

Set 是否展示左侧菜单栏

• **ENABLE** : (默认)进入web控制台展示左侧菜单栏
• **DISABLE** : 进入web控制台不展示左侧菜单栏

注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。

Parameters:

MenuStatus - 是否展示左侧菜单栏

• **ENABLE** : (默认)进入web控制台展示左侧菜单栏
• **DISABLE** : 进入web控制台不展示左侧菜单栏

注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。

getEndpoint

public String getEndpoint()

Get 生成链接的类型：

• **PC**：(默认)web控制台链接, 需要在PC浏览器中打开
• **CHANNEL**：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
• **SHORT_URL**：H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
• **APP**：APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序
• **H5**：H5长链接跳转H5链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面
• **SHORT_H5**：H5短链跳转H5的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签H5页面

Returns:

Endpoint 生成链接的类型：

• **PC**：(默认)web控制台链接, 需要在PC浏览器中打开
• **CHANNEL**：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
• **SHORT_URL**：H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
• **APP**：APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序
• **H5**：H5长链接跳转H5链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面
• **SHORT_H5**：H5短链跳转H5的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签H5页面

setEndpoint

public void setEndpoint(String Endpoint)

Set 生成链接的类型：

• **PC**：(默认)web控制台链接, 需要在PC浏览器中打开
• **CHANNEL**：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
• **SHORT_URL**：H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
• **APP**：APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序
• **H5**：H5长链接跳转H5链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面
• **SHORT_H5**：H5短链跳转H5的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签H5页面

Parameters:

Endpoint - 生成链接的类型：

• **PC**：(默认)web控制台链接, 需要在PC浏览器中打开
• **CHANNEL**：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
• **SHORT_URL**：H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
• **APP**：APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序
• **H5**：H5长链接跳转H5链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面
• **SHORT_H5**：H5短链跳转H5的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签H5页面

getAutoJumpBackEvent

public String getAutoJumpBackEvent()

Get 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括：

• **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序

Returns:

AutoJumpBackEvent 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括：

• **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序

setAutoJumpBackEvent

public void setAutoJumpBackEvent(String AutoJumpBackEvent)

Set 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括：

• **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序

Parameters:

AutoJumpBackEvent - 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括：

• **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序

getAuthorizationTypes

public Long[] getAuthorizationTypes()

Get 可选的此企业允许的授权方式, 可以设置的方式有:

• 1：上传授权书
• 2：转法定代表人授权
• 4：企业实名认证（信任第三方认证源）（此项有排他性, 选择后不能增添其他的方式）

注:

• 未选择信任第三方认证源时，如果是法人进行企业激活，仅支持法人扫脸直接授权，该配置不对此法人生效`
• 选择信任第三方认证源时，请先通过同步企业信息接口同步信息。
• 该参数仅在企业未激活时生效

Returns:

AuthorizationTypes 可选的此企业允许的授权方式, 可以设置的方式有:

• 1：上传授权书
• 2：转法定代表人授权
• 4：企业实名认证（信任第三方认证源）（此项有排他性, 选择后不能增添其他的方式）

注:

• 未选择信任第三方认证源时，如果是法人进行企业激活，仅支持法人扫脸直接授权，该配置不对此法人生效`
• 选择信任第三方认证源时，请先通过同步企业信息接口同步信息。
• 该参数仅在企业未激活时生效

setAuthorizationTypes

public void setAuthorizationTypes(Long[] AuthorizationTypes)

Set 可选的此企业允许的授权方式, 可以设置的方式有:

• 1：上传授权书
• 2：转法定代表人授权
• 4：企业实名认证（信任第三方认证源）（此项有排他性, 选择后不能增添其他的方式）

注:

• 未选择信任第三方认证源时，如果是法人进行企业激活，仅支持法人扫脸直接授权，该配置不对此法人生效`
• 选择信任第三方认证源时，请先通过同步企业信息接口同步信息。
• 该参数仅在企业未激活时生效

Parameters:

AuthorizationTypes - 可选的此企业允许的授权方式, 可以设置的方式有:

• 1：上传授权书
• 2：转法定代表人授权
• 4：企业实名认证（信任第三方认证源）（此项有排他性, 选择后不能增添其他的方式）

注:

• 未选择信任第三方认证源时，如果是法人进行企业激活，仅支持法人扫脸直接授权，该配置不对此法人生效`
• 选择信任第三方认证源时，请先通过同步企业信息接口同步信息。
• 该参数仅在企业未激活时生效

getOperator

@Deprecated
public UserInfo getOperator()

Deprecated.

Get 暂未开放

Returns:

Operator 暂未开放

setOperator

@Deprecated
public void setOperator(UserInfo Operator)

Deprecated.

Set 暂未开放

Parameters:

Operator - 暂未开放

getProxyOperatorIdCardNumber

public String getProxyOperatorIdCardNumber()

Get 子客经办人身份证 注意：`如果已同步，这里非空会更新同步的经办人身份证号，暂时只支持居民身份证类型`。

Returns:

ProxyOperatorIdCardNumber 子客经办人身份证 注意：`如果已同步，这里非空会更新同步的经办人身份证号，暂时只支持居民身份证类型`。

setProxyOperatorIdCardNumber

public void setProxyOperatorIdCardNumber(String ProxyOperatorIdCardNumber)

Set 子客经办人身份证 注意：`如果已同步，这里非空会更新同步的经办人身份证号，暂时只支持居民身份证类型`。

Parameters:

ProxyOperatorIdCardNumber - 子客经办人身份证 注意：`如果已同步，这里非空会更新同步的经办人身份证号，暂时只支持居民身份证类型`。

getAutoJumpUrl

public String getAutoJumpUrl()

Get 认证完成跳转链接。 注意：`此功能仅在Endpoint参数设置成 H5 或 PC时才有效`。

Returns:

AutoJumpUrl 认证完成跳转链接。 注意：`此功能仅在Endpoint参数设置成 H5 或 PC时才有效`。

setAutoJumpUrl

public void setAutoJumpUrl(String AutoJumpUrl)

Set 认证完成跳转链接。 注意：`此功能仅在Endpoint参数设置成 H5 或 PC时才有效`。

Parameters:

AutoJumpUrl - 认证完成跳转链接。 注意：`此功能仅在Endpoint参数设置成 H5 或 PC时才有效`。

getTopNavigationStatus

public String getTopNavigationStatus()

Get 是否展示头顶导航栏

• **ENABLE** : (默认)进入web控制台展示头顶导航栏
• **DISABLE** : 进入web控制台不展示头顶导航栏

注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。 点击查看头顶导航栏位置

Returns:

TopNavigationStatus 是否展示头顶导航栏

• **ENABLE** : (默认)进入web控制台展示头顶导航栏
• **DISABLE** : 进入web控制台不展示头顶导航栏

注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。 点击查看头顶导航栏位置

setTopNavigationStatus

public void setTopNavigationStatus(String TopNavigationStatus)

Set 是否展示头顶导航栏

• **ENABLE** : (默认)进入web控制台展示头顶导航栏
• **DISABLE** : 进入web控制台不展示头顶导航栏

注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。 点击查看头顶导航栏位置

Parameters:

TopNavigationStatus - 是否展示头顶导航栏

• **ENABLE** : (默认)进入web控制台展示头顶导航栏
• **DISABLE** : 进入web控制台不展示头顶导航栏

注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。 点击查看头顶导航栏位置

getAutoActive

public Boolean getAutoActive()

Get 是否自动激活子客

Returns:

AutoActive 是否自动激活子客

setAutoActive

public void setAutoActive(Boolean AutoActive)

Set 是否自动激活子客

Parameters:

AutoActive - 是否自动激活子客

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel