帮助文档

根据外部id查询成员

GET

https://api.maxhub.com/maxhub-blu/api/open/v5/member/external/{externalId}

请求参数

Path 参数

externalId

string

外部系统成员 ID

必需

示例值:

externalId123

Header 参数

X-Isp-Code

string

必需

组织码，获取路径：领效星云管理页面-> 我的企业 -> 企业ID

示例值:

Authorization

string

客户端令牌

必需

示例值:

Bearer {{sign_client_token}}

X-Isp-TraceId

string

必需

请求ID, 随机生成的32位uuid

示例值:

X-Auth-Sign

string

必需

签名，规则参考参数验签生成规则

示例值:

X-Auth-Timestamp

string

必需

请求发送的毫秒时间戳

示例值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.maxhub.com/maxhub-blu/api/open/v5/member/external/externalId123' \
--header 'X-Isp-Code: {{sign_orgCode}}' \
--header 'Authorization: Bearer {{sign_client_token}}' \
--header 'X-Isp-TraceId: {{uuid}}' \
--header 'X-Auth-Sign: {{sign}}' \
--header 'X-Auth-Timestamp: {{timestamp}}'

返回响应

🟢200成功

application/json

Body

code

number

返回码

必需

data

object

返回数据

必需

memberNo

string

组织描述

必需

jobTitle

string

职位

必需

teamId

string

团队 ID

必需

mobile

string

手机

必需

externalId

string

成员编号

必需

memberName

string

成员名字

必需

string

主键

必需

userId

string

用户 ID

必需

cardNo

string

工卡ID

必需

cardPhoto

string

工卡照地址

必需

string

邮箱

必需

message

string

返回信息

必需

示例

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": "1864590792589639680",
        "teamId": "0",
        "userId": "efea55c4-12b0-4f01-8958-2bb2008018de",
        "mobile": "15622222222",
        "email": "",
        "memberNo": “12312",
        "memberName": "janmee",
        "cardNo": “112",
        "cardPhoto": “www.test.com/1231",
        "jobTitle": “职位",
        "externalId": "externalId123"
    },
    "success": true,
    "failure": false
}

修改于 2024-12-25 09:32:25

查询成员

创建成员