昶戈开放平台
  1. 成员管理
昶戈开放平台
  • 昶戈开放平台
    • 概述
    • 对接步骤
    • 开始开发
      • 获取企业授权
    • 通讯录管理
      • 岗位管理
        • 批量添加岗位
        • 删除岗位
        • 获取岗位列表
        • 增加/修改岗位信息
        • 批量删除岗位成员数据
        • 增加岗位成员数据
      • 成员管理
        • 批量增加修改用户信息
          POST
        • 批量删除用户
          POST
        • 批量启用用户
          POST
        • 批量停用用户
          POST
        • 获取用户列表
          POST
        • 增加修改用户信息
          POST
        • 获取显示企业用户自定义字段列表 *
          GET
      • 产品线管理
        • 删除产品线
        • 获取产品线列表
        • 增加修改产品线人员信息
        • 增加修改产品线信息
      • 标签管理
        • 删除标签
        • 获取标签列表
        • 增加修改标签信息
        • 批量删除标签成员数据
        • 获取标签成员数据
        • 增加标签成员数据
      • 部门管理
        • 批量添加/修改部门
        • 批量添加部门(树形结构添加)
        • 删除部门
        • 获取部门列表
        • 增加修改部门信息
    • 授权登录
      • 免登录URL
    • 合作商开放接口
      • 企业配置
        • 获取合作商授权 *
        • 删除企业信息 *
        • 获取企业列表 *
        • 增加/修改企业信息 *
    • 消息和事件通知
      • 消息和事件通知
        • 订阅 *
        • 取消订阅 *
      • 消息和事件通知接收消息
        • 接收消息推送
    • 培训数据
      • 课程
        • 获取PC端首页第一个推荐课程
        • 获取移动端首页第一个推荐课程 *
      • 学员培训数据
        • 获取学员培训项目数据
        • 获取学员培训项目数据 V2
      • 实验室课程
        • 获取课程人员基础信息接口
        • 实验数据上传接口
    • 附录
      • 加密及算法
  1. 成员管理

获取用户列表

测试环境
https://api.test.tgtrain.cn
测试环境
https://api.test.tgtrain.cn
POST
/partner/member/list
/partner/member 合作商_成员管理
获取用户列表

请求参数

Query 参数
access_token
string 
企业密钥
必需
Body 参数application/json
account
string 
账号
可选
accounts
array[string]
账号列表
可选
activate
integer 
激活状态
可选
address
string 
地址
可选
birthday
array[string]
出生日期
可选
city
string 
城市
可选
country
string 
国家
可选
createTime
array[string]
创建日期
可选
createUser
integer 
创建人
可选
department
integer 
部门编号
可选
departmentCode
string 
部门组织编码
可选
director
integer 
直接上级
可选
email
string 
邮箱
可选
entryDate
array[string]
入职日期
可选
expireDate
array[string]
过期日期
可选
fields
array[string]
按KEY导出列
可选
gender
integer 
性别 1男 2女
可选
idList
array[integer]
人员编号列表
可选
identityId
string 
身份证
可选
identityType
integer 
身份类型
可选
keyword
string 
姓名+账号
可选
label
array[integer]
用户群编号
可选
major
integer 
产品线编号
可选
mobile
string 
手机号
可选
nickName
string 
昵称
可选
number
string 
工号
可选
own
boolean 
只看自己
可选
page
integer 
必需
*当前页(导出时可不填)
示例值:
1
pageSize
integer 
必需
*每页记录数量(导出时可不填)
示例值:
30
password
string 
导出数据时校验密码
可选
platforms
integer 
可选
是否绑定平台 1是 2否
position
integer 
岗位编号
可选
positionRank
string 
职称
可选
realName
string 
姓名
可选
refresh
integer 
刷新 1是
可选
remarks
string 
备注
可选
sort
integer 
可选
排序 0不处理 1正序排序 2倒序排序
sortKey
string 
按KEY排序
可选
status
integer 
可选
状态 1可用 6未审核 7审核失败 8停用
sub
boolean 
包含子
可选
tel
string 
座机号
可选
userType
integer 
可选
用户类型 1学员 2讲师 4教练 8管理员
示例
{
    "page": 40,
    "pageSize": 85,
    "positionRank": "sunt esse",
    "status": 34,
    "email": "c.rwtkbsku@qq.com",
    "activate": 89,
    "account": "fugiat",
    "mobile": "18191945196",
    "createTime": [
        "1974-10-19 08:35:45",
        "1975-06-09 22:02:48",
        "2016-12-05 21:37:41",
        "1970-09-23 12:48:19"
    ],
    "number": "46",
    "sub": true,
    "entryDate": [
        "1996-04-28",
        "1990-05-17",
        "1997-08-01",
        "2000-05-13"
    ],
    "keyword": "est",
    "major": 4,
    "expireDate": [
        "2017-03-24",
        "2021-08-12"
    ],
    "label": [
        38,
        47,
        59,
        16
    ],
    "identityId": "58",
    "userType": 55,
    "own": false,
    "accounts": [
        "commodo dolor Lorem incididunt nulla",
        "labore dolore esse eu"
    ],
    "sortKey": "nulla incididunt exercitation sed",
    "realName": "长出结见",
    "gender": 44,
    "fields": [
        "in sed ut ex",
        "in ad",
        "Ut fugiat",
        "ad cupidatat"
    ],
    "nickName": "武杰",
    "idList": [
        32,
        98,
        66,
        91
    ],
    "city": "山南地区",
    "departmentCode": "71",
    "department": 69,
    "identityType": 29,
    "address": "天津阿里地区安吉县",
    "birthday": [
        "1997-03-18",
        "1978-07-18",
        "2022-04-25"
    ],
    "refresh": 57,
    "country": "cupidatat elit nulla fugiat",
    "position": 88,
    "createUser": 84,
    "password": "reprehenderit magna voluptate",
    "tel": "13337375303",
    "remarks": "magna ad irure exercitation",
    "platforms": 74,
    "director": 74,
    "sort": 37
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.test.tgtrain.cn/partner/member/list?access_token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page": 40,
    "pageSize": 85,
    "positionRank": "sunt esse",
    "status": 34,
    "email": "c.rwtkbsku@qq.com",
    "activate": 89,
    "account": "fugiat",
    "mobile": "18191945196",
    "createTime": [
        "1974-10-19 08:35:45",
        "1975-06-09 22:02:48",
        "2016-12-05 21:37:41",
        "1970-09-23 12:48:19"
    ],
    "number": "46",
    "sub": true,
    "entryDate": [
        "1996-04-28",
        "1990-05-17",
        "1997-08-01",
        "2000-05-13"
    ],
    "keyword": "est",
    "major": 4,
    "expireDate": [
        "2017-03-24",
        "2021-08-12"
    ],
    "label": [
        38,
        47,
        59,
        16
    ],
    "identityId": "58",
    "userType": 55,
    "own": false,
    "accounts": [
        "commodo dolor Lorem incididunt nulla",
        "labore dolore esse eu"
    ],
    "sortKey": "nulla incididunt exercitation sed",
    "realName": "长出结见",
    "gender": 44,
    "fields": [
        "in sed ut ex",
        "in ad",
        "Ut fugiat",
        "ad cupidatat"
    ],
    "nickName": "武杰",
    "idList": [
        32,
        98,
        66,
        91
    ],
    "city": "山南地区",
    "departmentCode": "71",
    "department": 69,
    "identityType": 29,
    "address": "天津阿里地区安吉县",
    "birthday": [
        "1997-03-18",
        "1978-07-18",
        "2022-04-25"
    ],
    "refresh": 57,
    "country": "cupidatat elit nulla fugiat",
    "position": 88,
    "createUser": 84,
    "password": "reprehenderit magna voluptate",
    "tel": "13337375303",
    "remarks": "magna ad irure exercitation",
    "platforms": 74,
    "director": 74,
    "sort": 37
}'

返回响应

🟢200OK
application/json
Body
list
array[object (reslms.MemberDto) {48}] 
人员列表
可选
account
string 
账号
可选
activate
integer 
激活状态
可选
address
string 
地址
可选
birthday
integer 
出生日期 YMD
可选
city
string 
城市
可选
country
string 
国家
可选
createTime
integer 
创建时间
可选
createUid
integer 
创建UID
可选
createUser
string 
创建人
可选
department
string 
部门路径
可选
departmentCode
string 
组织机构编码
可选
departmentId
integer 
部门编号
可选
departmentName
string 
部门名称
可选
director
string 
直接主管
可选
directorId
integer 
直接主管编号
可选
distributeaccount
string 
业务账号
可选
district
string 
区县
可选
email
string 
邮箱
可选
entryDate
integer 
入职日期 YMD
可选
expireDate
integer 
到期日期 YMD
可选
gender
integer 
性别 1男 2女
可选
identityId
string 
身份证
可选
identityType
integer 
可选
身份类型 1身份证 2护照 3台湾通行证 4港澳通行证
label
string 
标签名称
可选
labelIDss
array[integer]
标签ID集合
可选
labelIds
array[integer]
标签ID集合
可选
labelNames
array[string]
标签名称集合
可选
labels
array[object (reslms.Label) {2}] 
标签集合
可选
major
string 
产品线路径
可选
majorId
integer 
产品线编号
可选
majorName
string 
产品线
可选
mobile
string 
手机号
可选
nickName
string 
昵称
可选
number
string 
工号
可选
openUid
string 
对接用户ID
可选
platforms
string 
绑定平台列表
可选
portrait
string 
肖像
可选
position
string 
岗位名称
可选
positionId
integer 
岗位编号
可选
positionRank
string 
职称
可选
province
string 
省份
可选
realName
string 
真实姓名
可选
remarks
string 
备注
可选
secretData
integer 
密级
可选
status
integer 
可选
状态 1可用 7未审核 8锁定 9删除
tel
string 
座机号
可选
userId
integer 
用户编号
可选
userType
integer 
可选
用户类型 1学员 2讲师 4教练 8管理员
page
integer 
当前页
可选
pageSize
integer 
每页记录数
可选
totals
integer 
总记录数
可选
示例
{
    "list": [
        {
            "account": "string",
            "activate": 0,
            "address": "string",
            "birthday": 0,
            "city": "string",
            "country": "string",
            "createTime": 0,
            "createUid": 0,
            "createUser": "string",
            "department": "string",
            "departmentCode": "string",
            "departmentId": 0,
            "departmentName": "string",
            "director": "string",
            "directorId": 0,
            "distributeaccount": "string",
            "district": "string",
            "email": "string",
            "entryDate": 0,
            "expireDate": 0,
            "gender": 0,
            "identityId": "string",
            "identityType": 0,
            "label": "string",
            "labelIDss": [
                0
            ],
            "labelIds": [
                0
            ],
            "labelNames": [
                "string"
            ],
            "labels": [
                {
                    "labelId": 0,
                    "labelName": "string"
                }
            ],
            "major": "string",
            "majorId": 0,
            "majorName": "string",
            "mobile": "string",
            "nickName": "string",
            "number": "string",
            "openUid": "string",
            "platforms": "string",
            "portrait": "string",
            "position": "string",
            "positionId": 0,
            "positionRank": "string",
            "province": "string",
            "realName": "string",
            "remarks": "string",
            "secretData": 0,
            "status": 0,
            "tel": "string",
            "userId": 0,
            "userType": 0
        }
    ],
    "page": 0,
    "pageSize": 0,
    "totals": 0
}
🔴500返回错误消息
修改于 2023-11-27 08:23:01
上一页
批量停用用户
下一页
增加修改用户信息
Built with