跳到主要内容

成员管理

增加成员

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

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

请求参数

名称类型必填描述
countryCodeString+86 国家编码
mobileString电话
namestring姓名
emailstring邮箱
jobNumberString工号
commentstring个人描述
organizationListList(Object)组织机构list
organizationIdString组织机构id
sequnceBigInteger排序
masterBoolean是否主组织
dutyString职务
extendFieldListList(Object)用户扩展字段
fieldCodeString扩展字段编码
fieldValueObject扩展字段值

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
}
]
}

返回参数

名称类型描述
codeInt错误码,非 0 表示失败
messageString错误描述
dataObject-
userIdString账号id

返回示例

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

删除成员

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

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

请求参数

名称类型必填描述
userIdString账号id

请求示例

{
"userId": "7f60350ab5b54fc6b6b22436946c1ead"
}

返回参数

名称类型描述
codeInt错误码,非 0 表示失败
messageString错误描述
dataObject-

返回示例

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

更新成员

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

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

请求参数

名称类型必填描述
userIdString账号id
namestring姓名
emailstring邮箱
jobNumberString工号
commentstring个人描述
organizationListList(Object)组织机构list
organizationIdString组织机构id
sequnceBigInteger排序
masterBoolean是否主组织
dutyString职务
extendFieldListList(Object)用户扩展字段
fieldCodeString扩展字段编码
fieldValueObject扩展字段值

请求示例

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

返回参数

名称类型描述
codeInt错误码,非 0 表示失败
messageString错误描述

返回示例

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

获取成员

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

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

请求参数

名称类型必填描述
userIdstring员工id

请求示例

{
"userId": "2a97ecaf2053427f9979be7273f9cabd"
}

返回参数

名称类型描述
codeInt错误码,非 0 表示失败
messageString错误描述
dataObject-
userIdStringid
countryCodeString+86 国家编码
mobileString电话
avataravatar头像
nameString姓名
emailString邮箱
jobNumberString工号
commentstring个人描述
organizationListList(Object)组织机构list
organizationIdString组织机构id
sequnceBigInteger排序
masterBoolean是否主组织
dutyString职务
extendFieldListList(Object)用户扩展字段
fieldCodeString扩展字段编码
fieldValueObject扩展字段值

返回示例

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

获取成员列表

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

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

请求参数

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

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

请求示例

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

返回参数

名称类型描述
codeInt错误码,非 0 表示失败
messageString错误描述
dataObject-
listList(Object)成员列表
userIdStringid
countryCodeString+86 国家编码
mobileString电话
avataravatar头像
nameString姓名
emailString邮箱
jobNumberString工号
commentstring个人描述
organizationListList(Object)组织机构list
organizationIdString组织机构id
sequnceBigInteger排序
masterBoolean是否主组织
dutyString职务
extendFieldListList(Object)用户扩展字段
fieldCodeString扩展字段编码
fieldValueObject扩展字段值

返回示例

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

手机号获取userid

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

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

请求参数

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

返回参数

名称类型描述
codeInt错误码,非 0 表示失败
messageString错误描述
dataObject-
listList(Object)成员列表
mobileString电话
userIdStringUserId

返回示例

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