契约锁 API

组织架构-员工详情

POST

/v2/employee/detail

获取员工详情。

请求参数

Header 参数

x-qys-open-accesstoken

string

可选

默认值:

x-qys-open-timestamp

string

可选

默认值:

x-qys-open-nonce

string

可选

默认值:

x-qys-open-signature

string

可选

默认值:

Body 参数application/json

user

object (UserRequest)

员工信息

必需

用于确定员工身份

contact

string

联系方式

必需

contactType

enum<string>

联系类型

必需

MOBILE（手机号），EMAIL（邮箱），EMPLOYEEID（员工ID），NUMBER（员工编号），BIZID（用户在对接方系统的唯一标识）

枚举值:

MOBILEEMAILEMPLOYEEIDNUMBERBIZID

name

string

姓名

可选

tenantName

string

子公司名称

可选

若该员工为子公司员工，则需要传递该值，默认为平台方主公司

示例

{
  "user": {
    "name": "{{addEmployeeName}}",
    "contact": "{{addEmployeeContact}}",
    "contactType": "MOBILE"
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://openapi.qiyuesuo.com/v2/employee/detail' \
--header 'x-qys-open-accesstoken: {{x-qys-open-accesstoken}}' \
--header 'x-qys-open-timestamp: {{x-qys-open-timestamp}}' \
--header 'x-qys-open-nonce: {{x-qys-open-nonce}}' \
--header 'x-qys-open-signature: {{x-qys-open-signature}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user": {
        "name": "{{addEmployeeName}}",
        "contact": "{{addEmployeeContact}}",
        "contactType": "MOBILE"
    }
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

result

object (EmployeeResponse)

必需

string

员工ID

必需

name

string

员工姓名

必需

mobile

string

手机号

可选

string

邮箱

可选

number

string

员工编号

可选

createTime

string

创建时间

可选

realName

boolean

是否实名认证

可选

enterpriseEmail

string

企业邮箱

可选

roles

array[string]

拥有的角色类型

可选

枚举值:

SYSTEM_ADMINLEGAL_PERSONSEAL_ADMINTEMPLATE_ADMINORDINARY_EMPLOYEE

示例

{
  "result": {
    "id": "3053242464719733490",
    "name": "曹杰",
    "createTime": "2023-01-18 16:15:30",
    "mobile": "11084005634",
    "realName": false,
    "roles": [
      "ORDINARY_EMPLOYEE"
    ]
  },
  "code": 0,
  "message": "SUCCESS"
}

组织架构-更新员工

组织架构-管理员工角色