企业成员管理

获取企业内所有成员
获取组织机构内成员
创建成员
删除成员
更新成员
成员信息变更同步

获取企业内所有成员

请求方式: GET
请求地址https://open.qingtui.cn/team/member/all/paged?access_token=ACCESS_TOKEN&page_size=PAGE_SIZE&request_page=REQUEST_PAGE

参数说明:

参数 必须 说明
access_token 接口调用凭证
page_size 分页返回时每页数据量,最大100
request_page 请求的页数,从1开始

正确返回结果示例:

{
    "total_count": 2,
    "has_more": true,
    "result_list": [
        {
            "name": "张三",
            "mail": null,
            "avatar": "https://avatarcdn.qingtui.cn/00XX.jpg",
            "comment": null,
            "guest": "yes",
            "mobile": "18000000000",
            "user_id":"userid002",
            "org_list": ["1ea6731d322548"],
        },
        {
            "name": "李四",
            "mail": "lisi@qingtui.cn",
            "avatar": "https://avatarcdn.qingtui.cn/00YY.jpg",
            "comment": "测试用户",
            "guest": "no",
            "mobile": "15111111111",
            "user_id":"userid001",
            "org_list": ["1ea6731d322548"],

         }
    ]
}

出错返回结果示例:

{
    "errcode": "40100",
    "errmsg": "page_size must be an integer less than  or equals to 100"
}

参数说明:

参数 说明
total_count 企业人员总数,含访客
has_more 是否还有更多未读的数据
name 名称
mail 邮箱
avatar 头像
comment 备注
guest 是否访客,yes是;no否
mobile 手机号码
user_id 企业内用户Id
org_list 所在的组织机构列表
errcode 错误代号
errmsg 错误信息

备注:

  1. 需要拥有读取企业成员信息的权限

获取组织机构内成员

请求方式: GET
请求地址https://open.qingtui.cn/team/member/org/paged?access_token=ACCESS_TOKEN&org_id=ORG_ID&page_size=PAGE_SIZE&request_page=REQUEST_PAGE

参数说明:

参数 必须 说明
access_token 接口调用凭证
org_id 组织机构Id,值为root时,为第一级组织机构
page_size 分页返回时每页数据量,最大100
request_page 请求的页数,从1开始

正确返回结果示例:

{
    "total_count": 2,
    "has_more": true,
    "result_list": [
        {
            "name": "张三",
            "mail": null,
            "avatar": "https://avatarcdn.qingtui.cn/00XX.jpg",
            "comment": null,
            "guest": "yes",
            "user_id":"id001",
            "mobile": "18000000000",
            "org_list": [
                "org_id0001"
            ]
        },
        {
            "name": "李四",
            "mail": "lisi@163.com",
            "avatar": "https://avatarcdn.qingtui.cn/00YY.jpg",
            "comment": "测试用户",
            "guest": "no",
            "user_id":"id002",
            "mobile": "15111111111",
            "org_list": [
                "org_id0001"
            ]

         }
    ]
}

出错返回结果示例:

{
    "errcode": "40100",
    "errmsg": "page_size must be an integer less than or equals to 100"
}

参数说明:

参数 说明
total_count 仅当前组织机构下用户数量(含访客),不包括子组织机构
has_more 是否还有更多的未读数据
name 名称
mail 邮箱
avatar 头像
comment 备注
guest 是否访客,yes是;no否
mobile 手机号码
user_id 企业内用户Id
org_list 组织机构列表
errcode 错误代号
errmsg 错误信息

备注:

  1. 此接口获取的用户仅为当前组织机构下的用户,不递归包含子组织机构用户
  2. 需要拥有读取企业成员信息的权限

创建成员

请求方式: POST
Content-Type:application/x-www-form-urlencoded
请求地址https://open.qingtui.cn/team/member/create/single?access_token=ACCESS_TOKEN

请求示例:

domain_id: 09d2fadcf
name:第一个成员
comment:测试
mail:XXXXX@163.com
mobile:18000000000
org_list[0]:09d2fadce
org_list[1]:09d2fadcd
password:qingtuitest

参数说明:

参数 必须 说明
access_token 接口调用凭证
name 成员名字
mail 电邮地址
comment 备注
mobile 电话号码
org_list 所在的组织机构列表
password 初始用户密码

正确返回结果示例:

{
     "user_id":"user001"
}

出错返回结果示例:

{
    "errcode": "40402",
    "errmsg": "invalid token"
}

参数说明:

参数 说明
user_id 企业内用户Id
errcode 错误代号
errmsg 错误信息

备注:

  1. 轻应用需要拥有变更企业成员的权限

删除成员

请求方式: POST Content-Type:application/x-www-form-urlencoded
请求地址https://open.qingtui.cn/team/member/delete/single?access_token=ACCESS_TOKEN

请求示例:

user_id:user001

参数说明:

参数 必须 说明
access_token 接口调用凭证
user_id 企业内用户Id

返回结果:

{
    "errcode": "0",
    "errmsg": "success"
}

参数说明:

参数 说明
errcode 错误代号,成功为0
errmsg 错误信息,如果成功是success,失败则显示失败原因

备注:

  1. 轻应用需要拥有变更企业成员信息的权限

更新成员

请求方式: POST
Content-Type:application/x-www-form-urlencoded
请求地址https://open.qingtui.cn/team/member/update/single?access_token=ACCESS_TOKEN

请求示例:

user_id:user002
comment:更新成员信息测试
name:张某某
org_list[0]:09d2fadce
org_list[1]:09d2fadcd

参数说明:

参数 必须 说明
access_token 接口调用凭证
user_id 企业内用户Id
name 要修改的名字
org_list 所在的组织机构列表
comment 要修改的备注信息

返回结果示例:

{
    "errcode": "0",
    "errmsg": "success"
}

参数说明:

参数 说明
errcode 错误代码,成功为0
errmsg 错误信息,如果成功是success,失败则显示失败原因

备注:

  1. 轻应用需要拥有变更企业成员信息的权限
  2. 不需要修改的字段可不传输,否则若传输为空值,则会删除以前的旧值

获取用户详情

请求方式: GET
请求地址https://open.qingtui.cn/team/member/detail?access_token=ACCESS_TOKEN&user_id=USER_ID

参数说明:

参数 必须 说明
access_token 接口调用凭证
user_id 企业内用户Id

正确返回结果示例:

{
    "user_id": "9dea319994aa526ea",
    "name": "张三",
    "mail": "zhangsan@163.com",
    "avatar": null,
    "comment": "测试用例",
    "guest": "no",
    "mobile": "18623000000",
    "org_list": [
        "org_001"
    ]
 }

出错返回结果示例:

{
    "errcode": "40402",
    "errmsg": "invalid token"
}

参数说明:

参数 说明
user_id 企业内用户Id
name 成员名字
mail 电邮地址
avatar 头像地址
comment 备注
mobile 电话号码
guest 是否访客,yes表示是
org_list 所在的组织机构列表
errcode 错误代号
errmsg 错误信息

备注:

  1. 轻应用需要拥有变更企业成员信息的权限

成员信息变更同步

请求方式: GET
请求地址https://open.qingtui.cn/team/member/sync?access_token=ACCESS_TOKEN&sync_time=SYNC_TIME&page_size=PAGE_SIZE&request_page=REQUEST\_PAGE

参数说明:

参数 必须 说明
access_token 接口调用凭证
sync_time 要同步的时间戳,毫秒格式,从此时间(含)后的变更都会返回
page_size 请求的每页成员数量
request_page 请求的页码,从1开始

返回结果:

{
    "total_count": 20,
    "has_more": true,
    "result_list": [
        {
            "name": "张三",
            "mail": null,
            "avatar": "https://avatarcdn.qingtui.cn/0000.jpg",
            "comment": null,
            "guest": "no",
            "mobile": "18500000000",
            “user_id”:“user001”,
            "update_time": 1496753901123,
            "org_list": [
                "",
                "5998de4ee8"
            ],
            "status":1
        },

        {
            "name": "李四",
            "mail": "",
            "avatar": "https://avatarcdn.qingtui.cn/0002.jpg",
            "comment": "",
            "guest": "no",
            "mobile": "13500000000",
            "user_id": "09d3858c0d0",
            "update_time": 1496753901001,
            "org_list": [
                "1ea6731d32",
                "5998de4ee8"
            ],
            "status":0
        }
    ]
}

出错返回结果示例:

{
    "errcode": "40402",
    "errmsg": "invalid token"
}

参数说明:

参数 说明
total_count 变更发生的总人数
has_more 是否还有更多的未读数据
name 名称
mail 邮箱
avatar 头像
comment 备注
guest 是否访客,yes是;no否
mobile 手机号码
org_list 所在的组织机构列表
update_time 更新时间戳(毫秒格式)
status 状态,0退出企业,1在企业中
errcode 错误代号
errmsg 错误信息

备注:

  1. 轻应用需要拥有读取企业成员信息的权限

results matching ""

    No results matching ""