同步企业经办人列表
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。 若经办人信息有误,或者需要修改,也可以先将之前的经办人做离职操作,然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SyncProxyOrganizationOperators。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 应用相关信息。 此接口Agent.AppId 和 Agent.ProxyOrganizationOpenId必填。 |
OperatorType | 是 | String | 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN" |
ProxyOrganizationOperators.N | 是 | Array of ProxyOrganizationOperator | 经办人信息列表,最大长度200 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Status | Integer | Status 同步状态,全部同步失败接口会直接报错 1-成功 2-部分成功 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
FailedList | Array of SyncFailReason | 同步失败经办人及其失败原因 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 同步子客企业经办人列表
同步子客企业经办人列表
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncProxyOrganizationOperators
<公共请求参数>
{
"OperatorType": "CREATE",
"Agent": {
"ProxyAppId": "c17bdf9c2a7bd****11f4d0200fef3d",
"ProxyOrganizationOpenId": "d7c13a8****9e3968c0ee248f04",
"AppId": "65fb0c5910***0aa382cc5ed0e"
},
"ProxyOrganizationOperators": [
{
"IdCardNumber": "61012****30000",
"Name": "张三",
"Mobile": "187*****000",
"IdCardType": "ID_CARD",
"Id": "00498cc8500be9c*****3aff766cac"
},
{
"IdCardNumber": "61012*****03130001",
"Name": "李四",
"Mobile": "158*****987",
"IdCardType": "ID_CARD",
"Id": "11498cc8500be9c*****3aff766cac"
}
]
}
输出示例
{
"Response": {
"FailedList": [
{
"Id": "11498cc8500be9c*****3aff766cac",
"Message": "手机号码不合法"
}
],
"RequestId": "s1631673278484637219",
"Status": 2
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.StaffAlreadyVerify | 员工已实名。 |
InternalError | 内部错误。 |
InternalError.Api | 其他API错误。 |
InternalError.Decryption | 解密错误。 |
InternalError.Encryption | 加密错误。 |
InternalError.System | 系统错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.EmptyParams | 参数为空。 |
InvalidParameter.ParamError | 参数错误。 |
LimitExceeded.ProxyOrganizationOperator | 经办人数据超出。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.NoApiAuth | 没有API权限。 |
OperationDenied.OperateType | 操作类型不支持。 |
OperationDenied.UserNotInOrganization | 用户不归属于当前企业,无法操作,请检查后重试。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.Application | 应用号不存在。 |
ResourceNotFound.ApplicationId | ApplicationId不存在。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |