跳到主要内容

同步企业经办人列表

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
Operator否UserInfo暂未开放

3. 输出参数​

参数名称类型描述
StatusIntegerStatus 同步状态,全部同步失败接口会直接报错
1-成功
2-部分成功
注意：此字段可能返回 null，表示取不到有效值。
FailedListArray of SyncFailReason同步失败经办人及其失败原因
注意：此字段可能返回 null，表示取不到有效值。
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 同步子客企业经办人列表​

同步子客企业经办人列表

输入示例​

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

{
    "OperatorType": "CREATE",
    "Agent": {
        "ProxyAppId": "c17bdf9c2a7bdxxxx11f4d0200fef3d",
        "ProxyOrganizationOpenId": "d7c13a8bxxxx9e3968c0ee248f04",
        "AppId": "65fb0c5910xxx0aa382cc5ed0e"
    },
    "ProxyOrganizationOperators": [
        {
            "IdCardNumber": "61012xxxxx30000",
            "Name": "张三",
            "Mobile": "187xxxxx000",
            "IdCardType": "ID_CARD",
            "Id": "00498cc8500be9cxxxxxxx3aff766cac"
        },
        {
            "IdCardNumber": "61012xxxxx03130001",
            "Name": "李四",
            "Mobile": "1000xxxxx000000",
            "IdCardType": "ID_CARD",
            "Id": "11498cc8500be9cxxxxxxx3aff766cac"
        }
    ]
}

输出示例​

{
    "Response": {
        "FailedList": [
            {
                "Id": "11498cc8500be9cxxxxxxx3aff766cac",
                "Message": "手机号码不合法"
            }
        ],
        "RequestId": "s1631673278484637219",
        "Status": 2
    }
}

5. 开发者资源​

腾讯云 API 平台​

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

API Inspector​

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

SDK​

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

命令行工具​

6. 错误码​

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

错误码描述
FailedOperation操作失败。
FailedOperation.StaffAlreadyVerify员工已实名。
InternalError内部错误。
InternalError.Api其他API错误。
InternalError.DbConnection数据库连接出错。
InternalError.DbRead数据库读取失败。
InternalError.DbUpdate数据库更新记录出错。
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.ApplicationIdApplicationId不存在。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
UnknownParameter未知参数错误。
UnsupportedOperation操作不支持。