com.tencentcloudapi.ess.v20201111.models

Class CreateUserMobileChangeUrlRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ess.v20201111.models.CreateUserMobileChangeUrlRequest

public class CreateUserMobileChangeUrlRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateUserMobileChangeUrlRequest()
CreateUserMobileChangeUrlRequest(CreateUserMobileChangeUrlRequest 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）为必填项。
String	getEndpoint() Get 要跳转的链接类型 HTTP：（默认）跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型) HTTP_SHORT_URL：跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型，此时返回短链 APP：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
String	getIdCardNumber() Get 要修改手机号用户的身份证号码，应符合以下规则 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。 如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为必填项。
String	getIdCardType() Get 要修改手机号用户的证件类型， 目前支持的账号类型如下： ID_CARD : （默认）中国大陆居民身份证 HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
String	getName() Get 要修改手机号用户的姓名，请确保填写的姓名为对方的真实姓名，而非昵称等代名。 如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为必填项。
UserInfo	getOperator() Get 执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
Long	getUserAccountType() Get 要修改手机号用户的类型。 0：员工 （默认）1：个人 如果是员工类型，只能修改本方员工，而不能修改其他企业的员工。 如果是个人类型，可不指定用户身份，生成的是固定的链接，当前登录电子签小程序的用户可进行换绑。
String	getUserData() Get 在用户完成实名认证后，其自定义数据将通过[手机号换绑回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%B8%89-%E4%B8%AA%E4%BA%BA%E5%91%98%E5%B7%A5%E6%89%8B%E6%9C%BA%E5%8F%B7%E4%BF%AE%E6%94%B9%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。 请注意： 此参数仅支持通过[获取c端用户实名链接](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口实名的用户生效。
String	getUserId() Get 如果您要修改企业员工用户ID，传递此用户ID即可，其他参数（Name，UserAccountType，IdCardType，IdCardNumber）将被忽略。如果不传此用户ID，则会使用其他参数来进行链接生成。 [点击查看用户ID的获取方式](https://res.ess.tencent.cn/cdn/tsign-developer-center/assets/images/%E7%BB%84%E7%BB%87%E6%9E%B6%E6%9E%84-47eb7105dd300e6dc0c502fba22688ae.png)
void	setAgent(Agent Agent) Set 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
void	setEndpoint(String Endpoint) Set 要跳转的链接类型 HTTP：（默认）跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型) HTTP_SHORT_URL：跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型，此时返回短链 APP：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
void	setIdCardNumber(String IdCardNumber) Set 要修改手机号用户的身份证号码，应符合以下规则 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。 如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为必填项。
void	setIdCardType(String IdCardType) Set 要修改手机号用户的证件类型， 目前支持的账号类型如下： ID_CARD : （默认）中国大陆居民身份证 HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
void	setName(String Name) Set 要修改手机号用户的姓名，请确保填写的姓名为对方的真实姓名，而非昵称等代名。 如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为必填项。
void	setOperator(UserInfo Operator) Set 执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
void	setUserAccountType(Long UserAccountType) Set 要修改手机号用户的类型。 0：员工 （默认）1：个人 如果是员工类型，只能修改本方员工，而不能修改其他企业的员工。 如果是个人类型，可不指定用户身份，生成的是固定的链接，当前登录电子签小程序的用户可进行换绑。
void	setUserData(String UserData) Set 在用户完成实名认证后，其自定义数据将通过[手机号换绑回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%B8%89-%E4%B8%AA%E4%BA%BA%E5%91%98%E5%B7%A5%E6%89%8B%E6%9C%BA%E5%8F%B7%E4%BF%AE%E6%94%B9%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。 请注意： 此参数仅支持通过[获取c端用户实名链接](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口实名的用户生效。
void	setUserId(String UserId) Set 如果您要修改企业员工用户ID，传递此用户ID即可，其他参数（Name，UserAccountType，IdCardType，IdCardNumber）将被忽略。如果不传此用户ID，则会使用其他参数来进行链接生成。 [点击查看用户ID的获取方式](https://res.ess.tencent.cn/cdn/tsign-developer-center/assets/images/%E7%BB%84%E7%BB%87%E6%9E%B6%E6%9E%84-47eb7105dd300e6dc0c502fba22688ae.png)
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

CreateUserMobileChangeUrlRequest

public CreateUserMobileChangeUrlRequest()

CreateUserMobileChangeUrlRequest

public CreateUserMobileChangeUrlRequest(CreateUserMobileChangeUrlRequest 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。 支持填入集团子公司经办人 userId 代发合同。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。

Returns:

Operator 执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。

setOperator

public void setOperator(UserInfo Operator)

Set 执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。

Parameters:

Operator - 执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。

getAgent

public Agent getAgent()

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

Returns:

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

setAgent

public void setAgent(Agent Agent)

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

Parameters:

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

getUserId

public String getUserId()

Get 如果您要修改企业员工用户ID，传递此用户ID即可，其他参数（Name，UserAccountType，IdCardType，IdCardNumber）将被忽略。如果不传此用户ID，则会使用其他参数来进行链接生成。 [点击查看用户ID的获取方式](https://res.ess.tencent.cn/cdn/tsign-developer-center/assets/images/%E7%BB%84%E7%BB%87%E6%9E%B6%E6%9E%84-47eb7105dd300e6dc0c502fba22688ae.png)

Returns:

UserId 如果您要修改企业员工用户ID，传递此用户ID即可，其他参数（Name，UserAccountType，IdCardType，IdCardNumber）将被忽略。如果不传此用户ID，则会使用其他参数来进行链接生成。 [点击查看用户ID的获取方式](https://res.ess.tencent.cn/cdn/tsign-developer-center/assets/images/%E7%BB%84%E7%BB%87%E6%9E%B6%E6%9E%84-47eb7105dd300e6dc0c502fba22688ae.png)

setUserId

public void setUserId(String UserId)

Set 如果您要修改企业员工用户ID，传递此用户ID即可，其他参数（Name，UserAccountType，IdCardType，IdCardNumber）将被忽略。如果不传此用户ID，则会使用其他参数来进行链接生成。 [点击查看用户ID的获取方式](https://res.ess.tencent.cn/cdn/tsign-developer-center/assets/images/%E7%BB%84%E7%BB%87%E6%9E%B6%E6%9E%84-47eb7105dd300e6dc0c502fba22688ae.png)

Parameters:

UserId - 如果您要修改企业员工用户ID，传递此用户ID即可，其他参数（Name，UserAccountType，IdCardType，IdCardNumber）将被忽略。如果不传此用户ID，则会使用其他参数来进行链接生成。 [点击查看用户ID的获取方式](https://res.ess.tencent.cn/cdn/tsign-developer-center/assets/images/%E7%BB%84%E7%BB%87%E6%9E%B6%E6%9E%84-47eb7105dd300e6dc0c502fba22688ae.png)

getUserAccountType

public Long getUserAccountType()

Get 要修改手机号用户的类型。

• 0：员工 （默认）
• 1：个人

如果是员工类型，只能修改本方员工，而不能修改其他企业的员工。 如果是个人类型，可不指定用户身份，生成的是固定的链接，当前登录电子签小程序的用户可进行换绑。

Returns:

UserAccountType 要修改手机号用户的类型。

• 0：员工 （默认）
• 1：个人

如果是员工类型，只能修改本方员工，而不能修改其他企业的员工。 如果是个人类型，可不指定用户身份，生成的是固定的链接，当前登录电子签小程序的用户可进行换绑。

setUserAccountType

public void setUserAccountType(Long UserAccountType)

Set 要修改手机号用户的类型。

• 0：员工 （默认）
• 1：个人

如果是员工类型，只能修改本方员工，而不能修改其他企业的员工。 如果是个人类型，可不指定用户身份，生成的是固定的链接，当前登录电子签小程序的用户可进行换绑。

Parameters:

UserAccountType - 要修改手机号用户的类型。

• 0：员工 （默认）
• 1：个人

如果是员工类型，只能修改本方员工，而不能修改其他企业的员工。 如果是个人类型，可不指定用户身份，生成的是固定的链接，当前登录电子签小程序的用户可进行换绑。

getName

public String getName()

Get 要修改手机号用户的姓名，请确保填写的姓名为对方的真实姓名，而非昵称等代名。 如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为必填项。

Returns:

Name 要修改手机号用户的姓名，请确保填写的姓名为对方的真实姓名，而非昵称等代名。 如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为必填项。

setName

public void setName(String Name)

Set 要修改手机号用户的姓名，请确保填写的姓名为对方的真实姓名，而非昵称等代名。 如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为必填项。

Parameters:

Name - 要修改手机号用户的姓名，请确保填写的姓名为对方的真实姓名，而非昵称等代名。 如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为必填项。

getIdCardType

public String getIdCardType()

Get 要修改手机号用户的证件类型， 目前支持的账号类型如下：

• ID_CARD : （默认）中国大陆居民身份证
• HONGKONG_AND_MACAO : 港澳居民来往内地通行证
• HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)

Returns:

IdCardType 要修改手机号用户的证件类型， 目前支持的账号类型如下：

• ID_CARD : （默认）中国大陆居民身份证
• HONGKONG_AND_MACAO : 港澳居民来往内地通行证
• HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)

setIdCardType

public void setIdCardType(String IdCardType)

Set 要修改手机号用户的证件类型， 目前支持的账号类型如下：

• ID_CARD : （默认）中国大陆居民身份证
• HONGKONG_AND_MACAO : 港澳居民来往内地通行证
• HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)

Parameters:

IdCardType - 要修改手机号用户的证件类型， 目前支持的账号类型如下：

• ID_CARD : （默认）中国大陆居民身份证
• HONGKONG_AND_MACAO : 港澳居民来往内地通行证
• HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)

getIdCardNumber

public String getIdCardNumber()

Get 要修改手机号用户的身份证号码，应符合以下规则

• 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
• 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
• 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。

如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为必填项。

Returns:

IdCardNumber 要修改手机号用户的身份证号码，应符合以下规则

• 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
• 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
• 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。

如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为必填项。

setIdCardNumber

public void setIdCardNumber(String IdCardNumber)

Set 要修改手机号用户的身份证号码，应符合以下规则

• 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
• 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
• 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。

如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为必填项。

Parameters:

IdCardNumber - 要修改手机号用户的身份证号码，应符合以下规则

• 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
• 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
• 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。

如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为必填项。

getEndpoint

public String getEndpoint()

Get 要跳转的链接类型

• HTTP：（默认）跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
• HTTP_SHORT_URL：跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型，此时返回短链
• APP：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型

Returns:

Endpoint 要跳转的链接类型

• HTTP：（默认）跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
• HTTP_SHORT_URL：跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型，此时返回短链
• APP：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型

setEndpoint

public void setEndpoint(String Endpoint)

Set 要跳转的链接类型

• HTTP：（默认）跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
• HTTP_SHORT_URL：跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型，此时返回短链
• APP：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型

Parameters:

Endpoint - 要跳转的链接类型

• HTTP：（默认）跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
• HTTP_SHORT_URL：跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型，此时返回短链
• APP：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型

getUserData

public String getUserData()

Get 在用户完成实名认证后，其自定义数据将通过[手机号换绑回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%B8%89-%E4%B8%AA%E4%BA%BA%E5%91%98%E5%B7%A5%E6%89%8B%E6%9C%BA%E5%8F%B7%E4%BF%AE%E6%94%B9%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。 请注意： 此参数仅支持通过[获取c端用户实名链接](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口实名的用户生效。

Returns:

UserData 在用户完成实名认证后，其自定义数据将通过[手机号换绑回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%B8%89-%E4%B8%AA%E4%BA%BA%E5%91%98%E5%B7%A5%E6%89%8B%E6%9C%BA%E5%8F%B7%E4%BF%AE%E6%94%B9%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。 请注意： 此参数仅支持通过[获取c端用户实名链接](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口实名的用户生效。

setUserData

public void setUserData(String UserData)

Set 在用户完成实名认证后，其自定义数据将通过[手机号换绑回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%B8%89-%E4%B8%AA%E4%BA%BA%E5%91%98%E5%B7%A5%E6%89%8B%E6%9C%BA%E5%8F%B7%E4%BF%AE%E6%94%B9%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。 请注意： 此参数仅支持通过[获取c端用户实名链接](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口实名的用户生效。

Parameters:

UserData - 在用户完成实名认证后，其自定义数据将通过[手机号换绑回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%B8%89-%E4%B8%AA%E4%BA%BA%E5%91%98%E5%B7%A5%E6%89%8B%E6%9C%BA%E5%8F%B7%E4%BF%AE%E6%94%B9%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。 请注意： 此参数仅支持通过[获取c端用户实名链接](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口实名的用户生效。

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel