Yach开放平台

# Yach用户管理

# 创建用户

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /user/create?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 请求包结构体

{
    "userid": "yach076421",
    "name": "张三",
    "dept_info" : [
            {
                "user_type":"全职员工",
                "dept_id":"6912",
                "empl_rcd":"0",
                "position":"效能与系统管理部研发工程师",
                "level":"2.1",
                "whether_flag":"false"
          },
          {
               "user_type":"兼职员工",
               "dept_id":"5",
               "empl_rcd":"1"
          }
    ],
    "mobile": "1xxxxxxxxxx",
    "email": "lucy@tal.com",
    "work_code": "076421",
    "whether_flag": false,
    "ex": {
        "okr":"xxxx",
        "未来人才":"xxxxxx"
    }
}

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
userid String 否 员工在当前企业内的唯一标识，也称staffId。由企业在创建时指定，并代表一定含义比如工号，创建后不可修改，企业内必须唯一。长度为1~64个字符
name String 是 成员名称。长度为1~64个字符
phone_area_code String 否 手机号区号 +86 中国大陆、 +852 中国香港 、+853 中国澳门、 +886 中国台湾 、+1美国 或 加拿大 、+44 英国
sex String 否 性别
dept_info JSON 是 json字符串 （包含empl_rcd、dept_id、position、user_type、level、whether_flag）
└ empl_rcd String 是 岗位：0、1、3 等
└ dept_id String 是 部门id
└ position String 否 职位信息。长度为0~64个字符
└ user_type String 是 员工类型：全职员工、全职教师、兼职员工、兼职教师、在编实习、专职教师、外包员工、其他
└ level String 否 职级 1.1 、2.1
└ whether_flag String 否 是否高管模式，true表示是，false表示不是。
mobile String 是 手机号码，企业内必须唯一，不可重复。
email String 否 邮箱。长度为0~64个字符。企业内必须唯一，不可重复
pic String 否 头像url
work_code String 否 员工工号，对应显示到OA后台和客户端个人资料的工号栏目。长度为0~64个字符
ex JSON 否 扩展属性，可以设置多种属性（在手机端个人信息页面显示）

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "userid": "yach076421"
     }
}

# 更新用户

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /user/update?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 请求包结构体

{
    "userid": "yach076421",
    "name": "张三",
    "dept_info" : [
            {
                "user_type":"全职员工",
                "dept_id":"6912",
                "empl_rcd":"0",
                "position":"效能与系统管理部研发工程师",
                "level":"2.1",
                "whether_flag":"false"
          },
          {
              "user_type":"兼职员工",
              "dept_id":"5",
              "empl_rcd":"1"
          }
    ],
    "mobile": "1xxxxxxxxxx",
    "email": "lucy@tal.com",
    "work_code": "076421",
    "whether_flag": false,
    "ex": {
        "okr":"xxxx",
        "未来人才":"xxxxxx"
    }
}

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
userid String 否 员工在当前企业内的唯一标识，也称staffId。由企业在创建时指定，并代表一定含义比如工号，创建后不可修改，企业内必须唯一。长度为1~64个字符
name String 是 成员名称。长度为1~64个字符
phone_area_code String 否 手机号区号 +86 中国大陆、 +852 中国香港 、+853 中国澳门、 +886 中国台湾 、+1美国 或 加拿大 、+44 英国
sex String 否 性别
dept_info JSON 是 json字符串 （包含empl_rcd、dept_id、position、user_type、level、whether_flag）
└ empl_rcd String 是 岗位：0、1、3 等
└ dept_id String 是 部门id
└ position String 否 职位信息。长度为0~64个字符
└ user_type String 是 员工类型：全职员工、全职教师、兼职员工、兼职教师、在编实习、专职教师、外包员工、其他
└ level String 否 职级 1.1 、2.1
└ whether_flag String 否 是否高管模式，true表示是，false表示不是。
mobile String 是 手机号码，企业内必须唯一，不可重复。
email String 否 邮箱。长度为0~64个字符。企业内必须唯一，不可重复
pic String 否 头像url
work_code String 否 员工工号，对应显示到OA后台和客户端个人资料的工号栏目。长度为0~64个字符
ex JSON 否 扩展属性，可以设置多种属性（在手机端个人信息页面显示）

返回值

{
    "code": 200,
    "msg": ""
}

# 删除用户

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /user/delete?access_token=ACCESS_TOKEN
请求方式 GET
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
userid String 是 员工userid

返回值

{
    "code": 200,
    "msg": ""
}

# 封禁用户

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /user/forbidden?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
user_id String 是 要禁用的用户yachid
operator_uid String 是 操作人的用户yachid
status String 是 用户状态（4:封禁 1:解禁)，目前只支持这两种设置
reason String 是 操作原因说明
text String 是 跟已禁用的用户聊天时的自动回复文本
at_user_list String 否 @人列表，传work_code，通过"|"分开

返回值

{
    "code": 200,
    "msg": "",
    "obj": []
}

# 通过userid获取用户详情

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /user/get?access_token=ACCESS_TOKEN
请求方式 GET
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
userid String 是 员工id

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "userid": "Yach076429",
        "dept_info": [
            {
                "user_type": "全职员工",
                "empl_rcd": "0",
                "position": "效能与系统管理部研发工程师",
                "level": "2.2",
                "whether_flag": false,
                "dept_id": "6912"
            },
            {
                "user_type": "兼职员工",
                "empl_rcd": "1",
                "position": null,
                "level": "0.0",
                "whether_flag": false,
                "dept_id": "5"
            }
        ],
        "work_code": "076429",
        "name": "邢晋刚",
        "mobile": "18601242463",
        "email": "xingjingang@tal.com",
        "pic": "https://yach-static.zhiyinlou.com/yach/avatar1/a5133760d21ba0e8c36fefef957963f4_s120.jpg",
        "sex": "男",
        "ex":"{\"okr\":\"http:\\/\\/www.zhiyinlou.com21111\",\"\未\来\人\才\":\"http:\\/\\/sso.100tal.com\"}"
    }
}

# 通过工号获取用户详情

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /user/get_by_workcode?access_token=ACCESS_TOKEN
请求方式 GET
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
work_code String 是 员工工号

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "userid": "Yach076429",
        "dept_info": [
            {
                "user_type": "全职员工",
                "empl_rcd": "0",
                "position": "效能与系统管理部研发工程师",
                "level": "2.2",
                "whether_flag": false,
                "dept_id": "6912"
            },
            {
                "user_type": "兼职员工",
                "empl_rcd": "1",
                "position": null,
                "level": "0.0",
                "whether_flag": false,
                "dept_id": "5"
            }
        ],
        "work_code": "076429",
        "name": "邢晋刚",
        "mobile": "18601242463",
        "email": "xingjingang@tal.com",
        "pic": "https://yach-static.zhiyinlou.com/yach/avatar1/a5133760d21ba0e8c36fefef957963f4_s120.jpg",
        "sex": "男",
        "ex":"{\"okr\":\"http:\\/\\/www.zhiyinlou.com21111\",\"\未\来\人\才\":\"http:\\/\\/sso.100tal.com\"}"
    }
}

# 通过手机号查询用户详情

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称 值
地址 /user/get_by_mobile?access_token=ACCESS_TOKEN
请求方式 GET
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 是 调用接口凭证
mobile String 是 员工手机号

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "userid": "Yach076429",
        "dept_info": [
            {
                "user_type": "全职员工",
                "empl_rcd": "0",
                "position": "效能与系统管理部研发工程师",
                "level": "2.2",
                "whether_flag": false,
                "dept_id": "6912"
            },
            {
                "user_type": "兼职员工",
                "empl_rcd": "1",
                "position": null,
                "level": "0.0",
                "whether_flag": false,
                "dept_id": "5"
            }
        ],
        "work_code": "076429",
        "name": "邢晋刚",
        "mobile": "18601242463",
        "email": "xingjingang@tal.com",
        "pic": "https://yach-static.zhiyinlou.com/yach/avatar1/a5133760d21ba0e8c36fefef957963f4_s120.jpg",
        "sex": "男",
        "ex":"{\"okr\":\"http:\\/\\/www.zhiyinlou.com21111\",\"\未\来\人\才\":\"http:\\/\\/sso.100tal.com\"}"
    }
}
上次更新: 1/19/2021, 11:34:19 AM

← 工作通知 →

foo