成员管理

增加成员
删除成员
更新成员
获取成员
获取成员列表
手机号获取userid

增加成员

调用本接口通过电话号码在企业创建新用户。

请求方式： POST
请求地址： https://open.qingtui.com/team/user?access_token=ACCESS_TOKEN

请求参数

名称 类型 必填 描述
countryCode String 是 +86 国家编码
mobile String 是 电话
name string 是 姓名
email string 否 邮箱
jobNumber String 否 工号
comment string 否 个人描述
organizationList List(Object) 否 组织机构list

organizationId

 String 是 组织机构id

sequnce

 BigInteger 否 排序

master

 Boolean 否 是否主组织

duty

 String 否 职务
extendFieldList List(Object) 否 用户扩展字段

fieldCode

 String 是 扩展字段编码

fieldValue

 Object 否 扩展字段值

mobile 需要在企业内唯一，否则会报错
email 需要在应用内唯一，否则会报错
jobNumber 需要在企业内唯一，否则会报错
sequnce 需要在该组织机构下唯一，否则会报错

请求示例

{
    "mobile": "18988888888",
    "comment": "备注334",
    "email": "",
    "jobNumber": "017960",
    "extendFieldList": [
        {
            "fieldCode": "kzzd",
            "fieldValue": "扩展字段值1"
        }
    ],
    "name": "阳君",
    "organizationList": [
        {
            "duty": "职务2",
            "master": false,
            "organizationId": "7f60350ab5b54fc6b6b22436946c1ead",
            "sequnce": 30
        }
    ]
}

返回参数

名称 类型 描述
code Int 错误码，非 0 表示失败
message String 错误描述
data Object -

userId

 String 账号id

返回示例

{
    "code": 0,
    "message": "",
    "data": {
        "userId": "7f60350ab5b54fc6b6b22436946c1ead"
    }
}

删除成员

调用本接口在企业删除成员。

请求方式： DELETE
请求地址： https://open.qingtui.com/team/user?access_token=ACCESS_TOKEN

请求参数

名称 类型 必填 描述
userId String 是 账号id

请求示例

{
    "userId": "7f60350ab5b54fc6b6b22436946c1ead"
}

返回参数

名称 类型 描述
code Int 错误码，非 0 表示失败
message String 错误描述
data Object -

返回示例

{
    "code": 0,
    "message": ""
}

更新成员

调用本接口更新指定的用户信息。

请求方式： PUT
请求地址： https://open.qingtui.com/team/user?access_token=ACCESS_TOKEN

请求参数

名称 类型 必填 描述
userId String 是 账号id
name string 是 姓名
email string 否 邮箱
jobNumber String 否 工号
comment string 否 个人描述
organizationList List(Object) 否 组织机构list

organizationId

 String 是 组织机构id

sequnce

 BigInteger 否 排序

master

 Boolean 否 是否主组织

duty

 String 否 职务
extendFieldList List(Object) 否 用户扩展字段

fieldCode

 String 是 扩展字段编码

fieldValue

 Object 否 扩展字段值

请求示例

{
    "accountId": "d569ec484f07416190425c931e1d855b",
    "comment": "备注334",
    "email": "",
    "jobNumber": "017961",
    "extendFieldList": [
        {
            "fieldCode": "kzzd",
            "fieldValue": "扩展字段值1"
        }
    ],
    "name": "三郎1334",
    "organizationList": [
        {
            "duty": "职务2",
            "master": false,
            "organizationId": "7f60350ab5b54fc6b6b22436946c1ead",
            "sequnce": 30
        }
    ]
}

返回参数

名称 类型 描述
code Int 错误码，非 0 表示失败
message String 错误描述

返回示例

{
    "code": 0,
    "message": ""
}

获取成员

调用本接口获取企业内成员。

请求方式： GET
请求地址： https://open.qingtui.com/team/user?access_token=ACCESS_TOKEN

请求参数

名称 类型 必填 描述
userId string 是 员工id

请求示例

{
    "userId": "2a97ecaf2053427f9979be7273f9cabd"
}

返回参数

名称 类型 描述
code Int 错误码，非 0 表示失败
message String 错误描述
data Object -

userId

 String id

countryCode

 String +86 国家编码

mobile

 String 电话

avatar

 avatar 头像

name

 String 姓名

email

 String 邮箱

jobNumber

 String 工号

comment

 string 个人描述

organizationList

 List(Object) 组织机构list

organizationId

 String 组织机构id

sequnce

 BigInteger 排序

master

 Boolean 是否主组织

duty

 String 职务

extendFieldList

 List(Object) 用户扩展字段

fieldCode

 String 扩展字段编码

fieldValue

 Object 扩展字段值

返回示例

{
    "code": 0,
    "message": ""
}

获取成员列表

调用本接口获取企业内所有成员，通过传入organizationId可指定部门中的用户信息。

请求方式： GET
请求地址： https://open.qingtui.com/team/user/list?access_token=ACCESS_TOKEN

请求参数

名称 类型 必填 描述
page Integer 是 分页，预期请求请求的页码，从1开始
size Integer 是 分页，预期请求的数据量，取值范围 1 ~ 1000
organizationId String 否 组织机构id，有值代表获取部门用户列表 ，值为root时，为第一级组织机构
needOrganization Boolean 否 返回的用户是否携带组织机构
needExtendField Boolean 否 返回的用户是否携带自定义的员工字段

needOrganization 或 needExtendField 为 YES 时，size 上限为100

请求示例

{
    "page": 1,
    "size": 1000
}

返回参数

名称 类型 描述
code Int 错误码，非 0 表示失败
message String 错误描述
data Object -

list

 List(Object) 成员列表

userId

 String id

countryCode

 String +86 国家编码

mobile

 String 电话

avatar

 avatar 头像

name

 String 姓名

email

 String 邮箱

jobNumber

 String 工号

comment

 string 个人描述

organizationList

 List(Object) 组织机构list

organizationId

 String 组织机构id

sequnce

 BigInteger 排序

master

 Boolean 是否主组织

duty

 String 职务

extendFieldList

 List(Object) 用户扩展字段

fieldCode

 String 扩展字段编码

fieldValue

 Object 扩展字段值

返回示例

{
    "code": 0,
    "message": ""
}

手机号获取userid

通过手机号获取其所对应的userId。

请求方式： GET
请求地址： https://open.qingtui.com/team/user/userid/list?access_token=ACCESS_TOKEN&mobileList=手机号1&mobileList=手机号2

请求参数

名称 类型 描述
mobileList List(String) 用户在轻推通讯录中的手机号码

返回参数

名称 类型 描述
code Int 错误码，非 0 表示失败
message String 错误描述
data Object -

list

 List(Object) 成员列表

mobile

 String 电话

userId

 String UserId

返回示例

{
    "code": 0,
    "message": ""
    "data": {
    "list": [{
        "mobile":"电话",
        "userId":"userId"
    }]
}

results matching ""

    No results matching ""