API 中心
有奖：语音产品征文挑战赛等你来> HOT
文档中心 > API 中心 > 腾讯电子签 > 个人账号管理相关接口 > 生成修改用户手机号链接

生成修改用户手机号链接

最近更新时间：2024-06-04 01:42:37

我的收藏

1. 接口描述

接口请求域名： ess.tencentcloudapi.com 。

该接口会生成一个手机号变更的链接，用户可以通过该链接进入电子签系统进行手机号的变更。
该接口支持员工和个人端手机号的变更。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateUserMobileChangeUrl。
Version 是 String 公共参数，本接口取值：2020-11-11。
Region 否 String 公共参数，此参数为可选参数。
Operator 是 UserInfo 执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
Agent 否 Agent 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
UserId 否 String 如果您要修改企业员工用户ID，传递此用户ID即可，其他参数（Name，UserAccountType，IdCardType，IdCardNumber）将被忽略。如果不传此用户ID，则会使用其他参数来进行链接生成。

点击查看用户ID的获取方式
示例值：yDRCLUUgygq2xun5UuO4zjEwg0vjoimj
UserAccountType 否 Integer 要修改手机号用户的类型。
  • 0：员工 （默认）
  • 1：个人


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

示例值：1
Name 否 String 要修改手机号用户的姓名，请确保填写的姓名为对方的真实姓名，而非昵称等代名。

如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为必填项。
示例值：典子谦
IdCardType 否 String 要修改手机号用户的证件类型，
目前支持的账号类型如下：

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


示例值：ID_CARD
IdCardNumber 否 String 要修改手机号用户的身份证号码，应符合以下规则
  • 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
  • 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
  • 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。

如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为必填项。
示例值：620000198802020000
Endpoint 否 String 要跳转的链接类型


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




示例值：APP
UserData 否 String 在用户完成实名认证后，其自定义数据将通过手机号换绑回调返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。

请注意：
此参数仅支持通过获取c端用户实名链接接口实名的用户生效。
示例值：MTIzNDU2Nzg5

3. 输出参数

参数名称 类型 描述
Url String 腾讯电子签小程序的实名认证链接。
如果没有传递，默认值是 HTTP。 链接的有效期均是 7 天。

- 如果EndPoint是APP，
得到的链接类似于pages/guide/index?to=MOBILE_CHANGE_INTENTION&shortKey=yDCZHUyOcExAlcOvNod0, 用法可以参考描述中的"跳转到小程序的实现"

- 如果EndPoint是HTTP，
得到的链接类似于https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=MOBILE_CHANGE_INTENTION&shortKey=yDCZHUyOcChrfpaswT0d，点击后会跳转到腾讯电子签小程序进行签署

- 如果EndPoint是HTTP_SHORT_URL，
得到的链接类似于https://essurl.cn/2n**42Nd，点击后会跳转到腾讯电子签小程序进行签署


注： 生成的链路后面不能再增加参数
示例值：https://essurl.cn/2n**42Nd
ExpireTime Integer 链接失效期限如下：


  • 如果指定更换绑定手机号的用户(指定用户ID或姓名等信息)，则设定的链接失效期限为7天后。
  • 如果没有指定更换绑定手机号的用户，则生成通用跳转到个人换手机号的界面，链接不会过期。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 生成修改个人手机号链接

生成修改个人手机号链接，
此用户是通过 获取c端用户实名链接实名的，
调用方知道用户的 userId， 所以使用 UserId 的方式生成手机号变更链接
生成的链接是 APP 的方式，所以参数中 Endpoint 为 APP

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateUserMobileChangeUrl
<公共请求参数>

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
        "ClientIp": "8.8.8.8"
    },
    "UserId": "yDCZmUUckpy1jpdxUBBx43i4P29qekYx",
    "Endpoint": "APP",
    "UserData": "MjMwMDAwMTM4Mw=="
}

输出示例

{
    "Response": {
        "ExpireTime": 1717751037,
        "RequestId": "s1717146237659391990",
        "Url": "pages/guide/index?to=MOBILE_CHANGE_INTENTION&shortKey=yDCZiUv2ByIvoFcoDTfb&autoJumpBack=true"
    }
}

示例2 使用二要素生成修改个人手机号链接

使用二要素（姓名/证件号）生成修改个人手机号链接
此用户是通过 获取c端用户实名链接实名的，
调用方不知道用户的 userId，但是有用户的二要素信息（姓名和证件号）
此时需要传递参数UserAccountType 为 1，表示个人
生成的链接是 短链的方式，所以参数中 Endpoint 为 HTTP_SHORT_URL

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateUserMobileChangeUrl
<公共请求参数>

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
        "ClientIp": "8.8.8.8"
    },
    "UserAccountType": 1,
    "Name": "典子谦",
    "IdCardType": "ID_CARD",
    "IdCardNumber": "620000198802020000",
    "Endpoint": "HTTP_SHORT_URL",
    "UserData": "MjMwMDAwMTM4Mw=="
}

输出示例

{
    "Response": {
        "ExpireTime": 1717754432,
        "RequestId": "s1717149632556325434",
        "Url": "https://test.essurl.cn/qLAEUBG2s4"
    }
}

示例3 使用二要素生成修改员工手机号链接

使用二要素（姓名/证件号）生成修改员工手机号链接
此用户是通过 获取c端用户实名链接实名的，
调用方不知道用户的 userId，但是有用户的二要素信息（姓名和证件号）
此时需要传递参数UserAccountType 为 0，表示员工
生成的链接是 短链的方式，所以参数中 Endpoint 为 HTTP_SHORT_URL

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateUserMobileChangeUrl
<公共请求参数>

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
        "ClientIp": "8.8.8.8"
    },
    "UserAccountType": 0,
    "Name": "典子谦",
    "IdCardType": "ID_CARD",
    "IdCardNumber": "620000198802020000",
    "Endpoint": "HTTP_SHORT_URL",
    "UserData": "MjMwMDAwMTM4Mw=="
}

输出示例

{
    "Response": {
        "ExpireTime": 1717754432,
        "RequestId": "s1717149632556325434",
        "Url": "https://test.essurl.cn/qHAEUjG2s4"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
中国站