读取员工 - 探马OpenAPI

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

salesId

string

企微salesId

可选

对应企微，企业内必须唯一。长度为1~64个字节。只能由数字、字母和“_-@.”四种字符组成，且第一个字符必须是数字或字母。系统进行唯一性检查时会忽略大小写。

id

string

对应探马唯一ID。

可选

查询员工时建议使用此id查询，salesId和id至少填一个

示例

{
    "salesId": "ZhangHaiSong",
    "id": "448175388600384"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v3/get-staff' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "salesId": "ZhangHaiSong",
    "id": "448175388600384"
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

示例：0

message

string

结构说明

必需

示例：success

data

object

数据体

必需

以下为data中的参数

id

integer

对应探马唯一ID

必需

示例：422102426277952

isUsing

boolean

员工探马后台是否启用

必需

corpid

string

公司id

必需

示例：ww9c553021xxxx

salesId

string

成员ID

必需

对应企微，企业内唯一。长度为1~64个字节。只能由数字、字母和“_-@.”四种字符组成，且第一个字符必须是数字或字母。系统进行唯一性检查时会忽略大小写。

name

string

成员名称

必需

长度为1~64个utf8字符

mobile

string

手机号码

必需

示例：15911132615

department

string

成员所属部门id列表

必需

示例：[3878,5510]

enable

integer

企微员工状态

必需

1启用；0禁用

isAdmin

integer

是否有管理权限

必需

1表示有，0表示没有。2 表示 API 用户，有管理权限

avatar

string

头像

可选

示例：http://wework.qpic.cn/bizmail/jB2qicfPzBE7S9qwPVIPP5sSKU5D5gXjeOD9bqKyU0RZLc2eQVZMYmg/0

fromQw

boolean

是否由企微数据初始化来

必需

email

string

邮箱

必需

示例：xx@tanmarket.cn

alias

string

成员别名

必需

长度1~64个utf8字符

isLeaderInDept

string

表示在所在的部门内是否为部门负责人。

必需

个数必须和参数department的个数一致，表示在所在的部门内是否为部门负责人。1表示为部门负责人，0表示非部门负责人。在审批等应用里可以用来标识上级审批人

isLogin

integer

是否可以登录探马后台

必需

1.可以，0.不可以

示例

{
    "code": 0,
    "message": "success",
    "data": {
        "id": 422102426277952,
        "corpid": "ww9c553021xxxx",
        "salesId": "ZhangHaiSong",
        "name": "张海松",
        "mobile": "15911132615",
        "department": "[3878,5510]",
        "enable": 0,
        "isAdmin": 0,
        "avatar": "http://wework.qpic.cn/bizmail/jB2qicfPzBE7S9qwPVIPP5sSKU5D5gXjeOD9bqKyU0RZLc2eQVZMYmg/0",
        "fromQw": true,
        "email": "xx@tanmarket.cn",
        "alias": "",
        "isLeaderInDept": "[0,0]",
        "isLogin": 1
    }
}

⚪-1错误