com.tencentcloudapi.ess.v20201111.models

Class CreateIntegrationEmployeesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ess.v20201111.models.CreateIntegrationEmployeesRequest

public class CreateIntegrationEmployeesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateIntegrationEmployeesRequest()
CreateIntegrationEmployeesRequest(CreateIntegrationEmployeesRequest 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

Modifier and Type	Method and Description
Agent	getAgent() Get 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
Staff[]	getEmployees() Get 待创建员工的信息最多不超过20个。 1.
String	getEndpoint() Get 要跳转的链接类型 **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链**APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型**H5**： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月注意：InvitationNotifyType 和 Endpoint 的关系图通知类型（InvitationNotifyType）EndpointSMS（默认）不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URLH5不需要传递，会将 Endpoint 默认设置为 H5NONE所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL
String	getInvitationNotifyType() Get 员工邀请方式 可通过以下途径进行设置： **SMS（默认）**：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。**H5**：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。**NONE**：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。
String	getJumpUrl() Get 回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。 注：`只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。`
UserInfo	getOperator() Get 执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
void	setAgent(Agent Agent) Set 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
void	setEmployees(Staff[] Employees) Set 待创建员工的信息最多不超过20个。 1.
void	setEndpoint(String Endpoint) Set 要跳转的链接类型 **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链**APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型**H5**： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月注意：InvitationNotifyType 和 Endpoint 的关系图通知类型（InvitationNotifyType）EndpointSMS（默认）不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URLH5不需要传递，会将 Endpoint 默认设置为 H5NONE所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL
void	setInvitationNotifyType(String InvitationNotifyType) Set 员工邀请方式 可通过以下途径进行设置： **SMS（默认）**：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。**H5**：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。**NONE**：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。
void	setJumpUrl(String JumpUrl) Set 回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。 注：`只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。`
void	setOperator(UserInfo Operator) Set 执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
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

CreateIntegrationEmployeesRequest

public CreateIntegrationEmployeesRequest()

CreateIntegrationEmployeesRequest

public CreateIntegrationEmployeesRequest(CreateIntegrationEmployeesRequest 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

getOperator

public UserInfo getOperator()

Get 执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`

Returns:

Operator 执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`

setOperator

public void setOperator(UserInfo Operator)

Set 执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`

Parameters:

Operator - 执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`

getEmployees

public Staff[] getEmployees()

Get 待创建员工的信息最多不超过20个。 1. 在创建企业微信员工的场景下** : 只需传入下面的参数，其他信息不支持设置。

参数	是否必填	含义
WeworkOpenId	是	企业微信用户账号ID

2. 在其他场景下** : 只需传入下面的参数，其他信息不支持设置。

参数	是否必填	含义
DisplayName	是	用户的真实名字
Mobile	是	用户手机号码
OpenId	否	用户的自定义ID
Email	否	用户的邮箱
Department.DepartmentId	否	用户加入后的部门ID

注: `每个手机号每天最多使用3次`

Returns:

Employees 待创建员工的信息最多不超过20个。 1. 在创建企业微信员工的场景下** : 只需传入下面的参数，其他信息不支持设置。

参数	是否必填	含义
WeworkOpenId	是	企业微信用户账号ID

2. 在其他场景下** : 只需传入下面的参数，其他信息不支持设置。

参数	是否必填	含义
DisplayName	是	用户的真实名字
Mobile	是	用户手机号码
OpenId	否	用户的自定义ID
Email	否	用户的邮箱
Department.DepartmentId	否	用户加入后的部门ID

注: `每个手机号每天最多使用3次`

setEmployees

public void setEmployees(Staff[] Employees)

Set 待创建员工的信息最多不超过20个。 1. 在创建企业微信员工的场景下** : 只需传入下面的参数，其他信息不支持设置。

参数	是否必填	含义
WeworkOpenId	是	企业微信用户账号ID

2. 在其他场景下** : 只需传入下面的参数，其他信息不支持设置。

参数	是否必填	含义
DisplayName	是	用户的真实名字
Mobile	是	用户手机号码
OpenId	否	用户的自定义ID
Email	否	用户的邮箱
Department.DepartmentId	否	用户加入后的部门ID

注: `每个手机号每天最多使用3次`

Parameters:

Employees - 待创建员工的信息最多不超过20个。 1. 在创建企业微信员工的场景下** : 只需传入下面的参数，其他信息不支持设置。

参数	是否必填	含义
WeworkOpenId	是	企业微信用户账号ID

2. 在其他场景下** : 只需传入下面的参数，其他信息不支持设置。

参数	是否必填	含义
DisplayName	是	用户的真实名字
Mobile	是	用户手机号码
OpenId	否	用户的自定义ID
Email	否	用户的邮箱
Department.DepartmentId	否	用户加入后的部门ID

注: `每个手机号每天最多使用3次`

getAgent

public Agent getAgent()

Get 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Returns:

Agent 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

setAgent

public void setAgent(Agent Agent)

Set 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

Agent - 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

getInvitationNotifyType

public String getInvitationNotifyType()

Get 员工邀请方式 可通过以下途径进行设置：

• **SMS（默认）**：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。
• **H5**：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。
• **NONE**：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。

Returns:

InvitationNotifyType 员工邀请方式 可通过以下途径进行设置：

• **SMS（默认）**：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。
• **H5**：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。
• **NONE**：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。

setInvitationNotifyType

public void setInvitationNotifyType(String InvitationNotifyType)

Set 员工邀请方式 可通过以下途径进行设置：

• **SMS（默认）**：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。
• **H5**：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。
• **NONE**：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。

Parameters:

InvitationNotifyType - 员工邀请方式 可通过以下途径进行设置：

• **SMS（默认）**：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。
• **H5**：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。
• **NONE**：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。

getJumpUrl

public String getJumpUrl()

Get 回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。 注：`只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。`

Returns:

JumpUrl 回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。 注：`只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。`

setJumpUrl

public void setJumpUrl(String JumpUrl)

Set 回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。 注：`只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。`

Parameters:

JumpUrl - 回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。 注：`只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。`

getEndpoint

public String getEndpoint()

Get 要跳转的链接类型

• **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
• **HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
• **APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
• **H5**： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月

注意：InvitationNotifyType 和 Endpoint 的关系图

通知类型（InvitationNotifyType）	Endpoint
SMS（默认）	不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URL
H5	不需要传递，会将 Endpoint 默认设置为 H5
NONE	所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL

Returns:

Endpoint 要跳转的链接类型

• **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
• **HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
• **APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
• **H5**： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月

注意：InvitationNotifyType 和 Endpoint 的关系图

通知类型（InvitationNotifyType）	Endpoint
SMS（默认）	不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URL
H5	不需要传递，会将 Endpoint 默认设置为 H5
NONE	所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL

setEndpoint

public void setEndpoint(String Endpoint)

Set 要跳转的链接类型

• **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
• **HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
• **APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
• **H5**： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月

注意：InvitationNotifyType 和 Endpoint 的关系图

通知类型（InvitationNotifyType）	Endpoint
SMS（默认）	不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URL
H5	不需要传递，会将 Endpoint 默认设置为 H5
NONE	所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL

Parameters:

Endpoint - 要跳转的链接类型

• **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
• **HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
• **APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
• **H5**： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月

注意：InvitationNotifyType 和 Endpoint 的关系图

通知类型（InvitationNotifyType）	Endpoint
SMS（默认）	不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URL
H5	不需要传递，会将 Endpoint 默认设置为 H5
NONE	所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.