创建员工信息变更链接
1. 接口描述
接口请求域名： essbasic.tencentcloudapi.com 。
生成员工信息变更链接，当前仅支持变更手机号
注:
- 目前仅支持修改员工手机号，待修改员工必须已经实名且在职
- 仅支持返回小程序链接
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateEmployeeChangeUrl。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-26。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Agent | 是 | Agent | 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
第三方平台子客企业和员工必须已经经过实名认证 |
| OpenId | 否 | String | 待修改的员工OpenId 示例值：user_open_id |
| NewMobile | 否 | String | 待修改的员工手机号，支持海外格式 示例值：+12 12345721 |
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: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEmployeeInfoChangeUrl
<公共请求参数>
{
"Agent": {
"AppId": "yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2",
"ProxyOperator": {
"OpenId": "kevinlcheng_1"
}
},
"OpenId": "kevinlcheng_1"
}
输出示例
{
"Response": {
"ExpireTime": 1741332331,
"MiniAppPath": "/pages/guide/index?shortKey=yDtSJUde8JFIMAykHz79",
"RequestId": "s1740727531055190955"
}
}
示例2 生成员工手机号变更链接-指定手机号
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEmployeeChangeUrl
<公共请求参数>
{
"Agent": {
"AppId": "yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2",
"ProxyOperator": {
"OpenId": "kevinlcheng_1"
}
},
"OpenId": "kevinlcheng_1",
"NewMobile": "+12 12345721"
}
输出示例
{
"Response": {
"ExpireTime": 1741332331,
"MiniAppPath": "/pages/guide/index?shortKey=yDtSJUde8JFIMAykHz79",
"RequestId": "s1740727531055190955"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ParamError | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.Application | 应用号不存在。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |
