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	getInvitationNotifyType() Get 员工邀请方式可通过以下方式进行设置： H5**：会生成H5的链接，点击链接进入H5的认证加入企业的逻辑。 SMS（默认）**：会通过短信或企业微信消息进行邀请。如果非企业微信场景，则是企业微信消息。其他场景则是短信通知，短信中包含链接，点击后进入微信小程序进行认证加入企业的逻辑。
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	setInvitationNotifyType(String InvitationNotifyType) Set 员工邀请方式可通过以下方式进行设置： H5**：会生成H5的链接，点击链接进入H5的认证加入企业的逻辑。 SMS（默认）**：会通过短信或企业微信消息进行邀请。如果非企业微信场景，则是企业微信消息。其他场景则是短信通知，短信中包含链接，点击后进入微信小程序进行认证加入企业的逻辑。
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, 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 员工邀请方式可通过以下方式进行设置： H5**：会生成H5的链接，点击链接进入H5的认证加入企业的逻辑。 SMS（默认）**：会通过短信或企业微信消息进行邀请。如果非企业微信场景，则是企业微信消息。其他场景则是短信通知，短信中包含链接，点击后进入微信小程序进行认证加入企业的逻辑。

Returns:

InvitationNotifyType 员工邀请方式可通过以下方式进行设置： H5**：会生成H5的链接，点击链接进入H5的认证加入企业的逻辑。 SMS（默认）**：会通过短信或企业微信消息进行邀请。如果非企业微信场景，则是企业微信消息。其他场景则是短信通知，短信中包含链接，点击后进入微信小程序进行认证加入企业的逻辑。

setInvitationNotifyType

public void setInvitationNotifyType(String InvitationNotifyType)

Set 员工邀请方式可通过以下方式进行设置： H5**：会生成H5的链接，点击链接进入H5的认证加入企业的逻辑。 SMS（默认）**：会通过短信或企业微信消息进行邀请。如果非企业微信场景，则是企业微信消息。其他场景则是短信通知，短信中包含链接，点击后进入微信小程序进行认证加入企业的逻辑。

Parameters:

InvitationNotifyType - 员工邀请方式可通过以下方式进行设置： H5**：会生成H5的链接，点击链接进入H5的认证加入企业的逻辑。 SMS（默认）**：会通过短信或企业微信消息进行邀请。如果非企业微信场景，则是企业微信消息。其他场景则是短信通知，短信中包含链接，点击后进入微信小程序进行认证加入企业的逻辑。

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场景下才生效， 其他方式下设置无效。`

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel