创建员工信息变更链接
1. 接口描述
接口请求域名： ess.tencentcloudapi.com 。
生成员工信息变更链接，当前仅支持变更手机号
注:
- 目前仅支持修改员工手机号，待修改员工必须已经实名且在职
- 仅支持返回小程序链接
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateEmployeeChangeUrl。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-11。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 |
| Operator | 否 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。 |
| UserId | 否 | String | 待修改的员工UserId 示例值：yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2 |
| NewMobile | 否 | String | 待修改的员工手机号 示例值：13100001111 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| MiniAppPath | String | 修改员工信息的小程序链接 跳转到腾讯电子签小程序的实现可以参考微信的官方文档:开放能力/打开 App 示例值：/pages/guide/index?shortKey=yDtSqUdeX03V7Rza3e37 |
| ExpireTime | Integer | 链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。 示例值：1683545268 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 生成员手机号变更链接-不指定手机号
修改员工手机号
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEmployeeInfoChangeUrl
<公共请求参数>
{
"Operator": {
"UserId": "yDRt2UUgygqxyp9yUuO4zjEwqXwsIljA"
},
"UserId": "yDRt2UUgygqxyp9yUuO4zjEwqXwsIljA"
}
输出示例
{
"Response": {
"ExpireTime": 1741332331,
"MiniAppPath": "/pages/guide/index?shortKey=yDtSJUde8JFIMAykHz79",
"RequestId": "s1740727531055190955"
}
}
示例2 生成员手机号变更链接-指定手机号
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEmployeeChangeUrl
<公共请求参数>
{
"Operator": {
"UserId": "yDRt2UUgygqxyp9yUuO4zjEwqXwsIljA"
},
"UserId": "yDRt2UUgygqxyp9yUuO4zjEwqXwsIljA",
"NewMobile": "13200001111"
}
输出示例
{
"Response": {
"ExpireTime": 1741332331,
"MiniAppPath": "/pages/guide/index?shortKey=yDtSJUde8JFIMAykHz79",
"RequestId": "s1740727531055190955"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |
