HCMLink文档中心

获取用户详情

请求方式:GET

请求地址:

https://open-ushu.hillinsight.tech/cgi/user/get?access_token=TOKEN&open_id=OPEN_ID&portal=PORTAL

参数说明

参数 必须 说明
access_token 是 接口调用凭证
portal 是 企业portal
open_id 是 用户open_id
with_external_contacts 否 是否查询外部联系人 0-否，1-是，默认1

返回结果

{
  "error_code": 0,
  "message": "Success",
  "result": {
    "area": "+86",
    "avatar": "",
    "dpt": [
      {
        "dept_id": 1,
        "name": "部门1"
      }
    ],
    "email": "weir@ii.co",
    "ext": {},
    "landline_tel": "",
    "name_cn": "张三",
    "name_en": "张三",
    "open_id": "747958b015589720bd5b6eb8bb2dd702",
    "portal": "lalala",
    "role": [],
    "status": 1,
    "tel": "18366113322",
    "title": "",
    "user_id": "wokof",
    "wechat": "diij9",
    "is_external_contact" : 1,
    "real_portal": "balabala"
  }
}
参数 说明
error_code 返回码
message 对返回码的文本描述内容
area 手机国际区号
dpt->dept_id 所属部门id
dpt->name 所属部门名称
email 邮箱
landline_tel 座机号码
name_cn 中文姓名
name_en 英文姓名
open_id 平台人员唯一id
portal 所属企业唯一标识
status 人员状态 0已删除，1正常，2未激活，3被冻结
tel 手机号码
user_id 企业内人员唯一标识
wechat 微信号
is_external_contact 是否为外部联系人，0-否，1-是
real_portal 当用户为外部联系人时，该字段返回外部联系人实际所在租户

通过邮箱查询用户

请求方式:GET

请求地址:

https://open-ushu.hillinsight.tech/cgi/user/search?access_token=TOKEN&portal=PORTAL&query=123456

接口说明

  1. 该接口用于通过邮箱精确匹配用户
  2. 该接口需申请权限才可使用

参数说明

参数 必须 说明 示例
access_token 是 接口调用凭证
portal 是 企业portal
query 是 搜索词-邮箱
with_external_contacts 否 是否查询外部联系人 0-否，1-是，默认1

返回结果

{
  "error_code": 0,
  "message": "Success",
  "result": [
    {
    "area": "+86",
    "avatar": "",
    "dpt": [
      {
        "dept_id": 1,
        "name": "部门1"
      }
    ],
    "email": "weir@ii.co",
    "ext": {},
    "landline_tel": "",
    "name_cn": "张三",
    "name_en": "张三",
    "open_id": "747958b015589720bd5b6eb8bb2dd702",
    "portal": "lalala",
    "role": [],
    "status": 1,
    "tel": "18366113322",
    "title": "",
    "user_id": "wokof",
    "wechat": "diij9",
    "real_portal": "Gd8VgKrp",    //当用户为外部联系人时，该字段返回外部联系人实际所在租户
    "is_external_contact": 0  
  }
]
}
参数 说明
error_code 返回码
message 对返回码的文本描述内容
area 手机国际区号
dpt->dept_id 所属部门id
dpt->name 所属部门名称
email 邮箱
landline_tel 座机号码
name_cn 中文姓名
name_en 英文姓名
open_id 平台人员唯一id
portal 所属企业唯一标识
status 人员状态 0已删除，1正常，2未激活，3被冻结
tel 手机号码
user_id 企业内人员唯一标识
wechat 微信号
is_external_contact 是否为外部联系人，0-否，1-是
real_portal 当用户为外部联系人时，该字段返回外部联系人实际所在租户

← 发送应用消息 →