获取机构信息

使用场景: 获取机构的信息,可用于登录页的信息展示

  • 支持获取机构自身的信息
  • 支持获取下级和下下级等有管理权限的机构信息

权限说明

权限项 说明 备注
应用是否需要申请白名单 不需要
用户凭证 未支持
机构凭证 支持

请求方式: POST(HTTPS

请求地址: https://oapi.epaas.qq.com/corp/info

Query参数:

参数 类型 必填 说明
access_token string 接口调用凭证

Body参数:

参数 类型 必须 说明
corpid uint32 不填或填0表示查询自身机构信息
非0表示查询指定机构信息,仅支持查询下级(含子孙机)机构
extend_fields []string 应用托管资料字段

请求示例:

POST https://oapi.epaas.qq.com/corp/info?access_token=ACCESS_TOKEN

请求包体:

{
  "corpid": 1122331,
  "extend_fields": ["FieldA"]
}

返回参数:

参数 类型 说明
errcode int32 返回码
errmsg string 对返回码的文本描述内容
name string 机构名
logo string 机构Logo
type string 机构类型
ORG;无意义
AGENT;代理商
OFFICE;上级单位(教育局)
GROUP;总集(集团)
SCHOOL;学校
SUPADMIN;超管后台
DEVELOPERS;开发商
GUESTS;访客
INDEPENDENT;独立组织,提供给作业非群渠道用户
TENANT;租户机构
VirtualOrg=;虚拟机构
country string 国家
province string 省,参数值通过接口《批量查询地区详情》 查询
city string 市,参数值通过接口《批量查询地区详情》 查询
area string 区,参数值通过接口《批量查询地区详情》 查询
edu_type int32 版本类型,参数值含义参考《版本类型对照表》
section_list []int32 学校类型,参数值含义参考《学校类型对照表(旧)》
code string 机构代码
level uint32 层级
province_code int32 省份行政区代码,参数值通过接口《批量查询地区详情》 查询
city_code int32 市行政区代码,参数值通过接口《批量查询地区详情》 查询
area_code int32 区县行政区代码,参数值通过接口《批量查询地区详情》 查询
qywx_corpid string 机构绑定的企业微信CorpId
extend_profile string 应用托管资料
tenant_id string 租户id
province_id int32 省份ID
city_id int32 城市ID
area_id int32 区/县ID

备注:返回的source(开源来源)和app_template(应用模版)为旧版待废弃字段,新应用忽略即可

返回示例:

{
    "errcode": 0,
    "errmsg": "ok",
    "name": "name",
    "logo": "logo",
    "type": "ORG", 
    "country": "country",
    "province": "province",
    "city": "city",
    "area": "area",
    "edu_type": 123, 
    "section_list": [
        1,
        2
    ], 
    "code": "code", 
    "level": 1, 
    "province_code": 123, 
    "city_code": 123, 
    "area_code": 123,
    "source": 3,
    "app_template": 5,
    "qywx_corpid": "wwe6e3b576eebe2584",
    "extend_profile": "{\"FieldA\": 01}",
    "tenant_id": "1",
    "province_id": 10,
    "city_id": 10,
    "area_id": 10
}

机构管理员相关

获取机构管理员列表

使用场景: 获取学校或行政单位的管理员列表,用于判断操作权限。

权限说明

权限项 说明 备注
应用是否需要申请白名单 不需要
用户凭证 未支持
机构凭证 支持

请求方式: GET(HTTPS

请求地址: https://oapi.epaas.qq.com/corp/admin/list

Query参数:

参数 类型 必填 说明
access_token string 接口调用凭证
hide_creator bool 是否隐藏创建者
sub_corpid uint32 下级机构id(或中心校的子校id)

Body参数:

返回参数:

参数 类型 说明
errcode int32 返回码
errmsg string 对返回码的文本描述内容
data_list 列表
data_list.userid string 用户ID
data_list.name string 名称
data_list.role_id int32 角色id, 参考角色类型
data_list.department []uint32 用户所在的部门id列表
data_list.admin_type []string 管理员类型列表 包括:"创建者","超级管理员","部门管理员"

请求示例:

GET https://oapi.epaas.qq.com/corp/admin/list?access_token=ACCESS_TOKEN&hide_creator=true

请求包体:

返回包体:

{
    "errcode": 0,
    "errmsg": "ok",
    "total": 1,
    "data_list":[
        {
            "userid": "123",
            "name": "小王",
            "role_id" : 12,
            "department" : [1,2,3],
            "admin_type": ["管理员","高级管理员"]        
        }
    ]
}

获取机构职位列表

使用场景: 获取学校下的职位列表,用于教师的职位选择或展示。

权限说明

权限项 说明 备注
应用是否需要申请白名单 不需要
用户凭证 未支持
机构凭证 支持 后台管理场景使用

请求方式: GET(HTTPS

请求地址: https://oapi.epaas.qq.com/corp/title/list

Query参数:

参数 类型 必填 说明
access_token string 接口调用凭证

返回参数:

参数 类型 说明
errcode int32 返回码
errmsg string 对返回码的文本描述内容
data_list 职位列表
data_list.id int32 职位id
data_list.name string 职位名
data_list.order int32 职位排序
data_list.editable int32 是否可编辑:0-不可编辑,1-可编辑

请求示例:

GET https://oapi.epaas.qq.com/corp/title/list?access_token=ACCESS_TOKEN

请求包体:

返回包体:

{
    "errcode": 0,
    "errmsg": "ok",
    "total": 2,
    "data_list":[
        {
            "id": 123,            
            "name": "校长",
            "order": 6,
            "editable": 1          
        },
        {
            "id": 123,            
            "name": "教导主任",
            "order": 7,
            "editable": 1         
        }
    ]
}

更新学校老师学生首次登录是否需要修改密码

使用场景: 更新学校老师学生首次登录是否需要修改密码

权限说明

权限项 说明 备注
应用是否需要申请白名单 需要
用户凭证 未支持
机构凭证 支持

请求方式: POST(HTTPS

请求地址: https://oapi.epaas.qq.com/corp/school/update_password_first

Query参数:

参数 类型 必填 说明
access_token string 调用接口凭证

Body参数:

参数 类型 说明
teacher_update_password_first int 0:不需要;1:需要
student_update_password_first int 0:不需要;1:需要

返回参数:

参数 类型 说明
errcode int32 返回码,0为正常
errmsg string 对返回码的文本描述内容

请求示例:

POST https://oapi.epaas.qq.com/corp/school/update_password_first?access_token=ACCESS_TOKEN

请求包体:

{
  "teacher_update_password_first": 0,
  "student_update_password_first": 0
}

返回包体:

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

查询是否为机构管理员

使用场景: 判断用户是否具有指定的管理员角色

  • 支持教育局和学校

权限说明

权限项 说明 备注
应用是否需要申请白名单 不需要
用户凭证 支持
机构凭证 支持

请求方式: POST(HTTPS

请求地址: https://oapi.epaas.qq.com/corp/is_org_admin

Query参数:

参数 类型 必填 说明
access_token string 接口调用凭证

Body参数:

参数 类型 必填 说明
userid string 用户ID,用户凭证从登录态取userid,机构凭证必须传userid
admin_type_list []uint32 管理员类型列表(学校创建者 1, 学校超级管理员 3, 校长 9; 教育局创建者 22, 教育局超管 23,教育局局长 24),如果不填,学校默认为[1,3],教育局默认为[22,23]

返回参数:

参数 类型 说明
errcode int32 返回码
errmsg string 对返回码的文本描述内容
is_admin bool 是否为机构管理员

请求示例:

POST https://oapi.epaas.qq.com/corp/is_org_admin?access_token=ACCESS_TOKEN

请求包体:

{
  "userid":"user_123",
  "admin_type_list": [1,3,9]
}

返回示例:

{
    "errcode": 0,
    "errmsg": "ok",
    "is_admin": true
}

添加机构管理员

请求地址: /https://oapi.epaas.qq.com/auth/user/add_dpt_admin?access_token=USER_ACCESS_TOKEN

接口说明:支持教育局和学校,支持给下属教育局和学校添加管理员

权限说明

权限项 说明 备注
应用是否需要申请白名单 需要
用户凭证 支持 需要机构管理员
机构凭证 支持 -

请求方法: POST

请求参数:

参数 必须 类型 说明
access_token string 调用接口凭证,由/open/access_token获得
corpid string 机构id,空表示自身机构,支持下属机构(支持中心校)
userid string 用户id

返回结果:

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

参数说明:

参数 说明
errcode 返回码,0为正常
errmsg 对返回码的文本描述内容

删除机构或部门管理员

请求地址: /https://oapi.epaas.qq.com/auth/user/delete_dpt_admin?access_token=USER_ACCESS_TOKEN

接口说明:支持教育局和学校,支持给下属教育局和学校删除管理员

权限说明

权限项 说明 备注
应用是否需要申请白名单 需要
用户凭证 支持 必须是学校的超级管理员,或教育局的超级管理员
机构凭证 支持 -

请求方法: POST

请求参数:

参数 必须 类型 说明
access_token string 接口调用凭证,由/open/access_token获得
userid string 用户id
corpid string 机构id,空表示自身机构,支持下属机构

返回结果:

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

参数说明:

参数 说明
errcode 返回码,0为正常
errmsg 对返回码的文本描述内容

查询管理员详情

请求地址: /https://oapi.epaas.qq.com/auth/user/dpt_admin_info?access_token=ACCESS_TOKEN

接口说明:支持教育局和学校,查询超级管理员和部门管理员详情

权限说明

权限项 说明 备注
应用是否需要申请白名单 不需要
用户凭证 支持 需要机构管理员
机构凭证 支持 -

请求方法: GET

请求示例: https://oapi.epaas.qq.com/auth/user/dpt_admin_info?access_token=ACCESS_TOKEN&userid=100001

请求参数:

参数 必须 类型 说明
access_token string 接口调用凭证,由/open/access_token获得
userid string 用户id

返回结果:

{
    "errmsg": "ok",
    "errcode": 0,
    "department_ids": [
        5165437,
        5366682
    ],
    "name": "测试",
    "userid": "10001",
    "admin_types": [
        4
    ],
    "range_type": 3
}

参数说明:

参数 说明
errcode 返回码,0为正常
errmsg 对返回码的文本描述内容
department_ids 管理的部门id列表
name 用户名称
userid 用户id
admin_types 管理员类型 4:学校部门管理员 25:教育局部门管理员 其他参考:参考用户组类型
range_type -1:非部门管理员 1:本校全部组织架构成员 2:当前管理员本部门及下辖部门 3:指定部门范围

查询部门管理员列表

请求地址: /https://oapi.epaas.qq.com/auth/user/dpt_admin_users?access_token=USER_ACCESS_TOKEN

接口说明:支持教育局和学校,查询部门管理员列表

权限说明

权限项 说明 备注
应用是否需要申请白名单 不需要
用户凭证 支持 需要机构管理员
机构凭证 支持 -

请求方法: POST

请求示例:

{
  "app_role_ids":["4"],
  "page_index":1,
  "page_size":30,
  "department_ids":[]
}

请求参数: 注意:如果入参department_ids不为空,那么会查询所有匹配到的部门管理员,这个时候不会做分页处理,也就是会忽略入参page_index和page_size

参数 必须 类型 说明
access_token string 接口调用凭证,由/open/access_token获得
app_role_ids []string 部门管理员的role_id, 学校部门管理员:"4", 教育局部门管理员:"25"
department_ids []uint32 指定部门id列表 空:查询所有部门
page_index int 第几页
page_size int 每页数量

返回结果:

{
    "errmsg": "ok",
    "errcode": 0,
    "data_list": [
        {
            "userid": "3729824015",
            "name": "祝福",
            "mobile": "189****1234",
            "user_number": "1111122222",
            "app_role_id": "4",
            "app_role_name": "部门管理员",
            "department_ids":[1001,1002]
        },
        {
            "userid": "3729824011",
            "name": "李金全",
            "mobile": "182****1234",
            "user_number": "111222333",
            "app_role_id": "4",
            "app_role_name": "部门管理员",
            "department_ids":[1001]
        }
    ],
    "total": 2
}

参数说明:

参数 说明
errcode 返回码,0为正常
errmsg 对返回码的文本描述内容
total 总数
data_list 用户列表
data_list.userid 用户id
data_list.name 用户名称
data_list.mobile 手机号
data_list.user_number 教工号
data_list.app_role_id 部门管理员的role_id 学校部门管理员:4 教育局部门管理员:25
data_list.app_role_name 部门管理员
data_list.department_ids 用户管理的部门id列表

添加或修改部门管理员

请求地址: /https://oapi.epaas.qq.com/auth/user/edit_dpt_admin_info?access_token=USER_ACCESS_TOKEN

接口说明:支持教育局和学校,添加或修改部门管理员

权限说明

权限项 说明 备注
应用是否需要申请白名单 需要
用户凭证 支持 需要机构管理员
机构凭证 支持 -

请求方法: POST

请求示例:

{
  "userids":["100001","100002],
  "app_role_id":"4",
  "department_ids":[1234]
}

请求参数:

参数 必须 类型 说明
access_token string 接口调用凭证,由/open/access_token获得
userids []string 用户id列表
app_role_id string 部门管理员的role_id, 学校传"4", 教育局传"25"
department_ids []int 部门id列表

返回结果:

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

参数说明:

参数 说明
errcode 返回码,0为正常
errmsg 对返回码的文本描述内容

根据角色获取用户列表

使用场景: 根据角色id获取学校或行政单位的用户列表, 可查询各类管理员

权限说明

权限项 说明 备注
应用是否需要申请白名单 不需要
用户凭证 支持 必须是机构的超级管理员
机构凭证 支持 -

请求方式: GET(HTTPS

请求地址: https://oapi.epaas.qq.com/auth/role/users

Query参数:

参数 类型 必填 说明
access_token string 接口调用凭证
app_role_id uint32 用户组类型 参考用户组类型
keyword string 用户名称,模糊搜索
page_index uint32 第几页
page_size uint32 每页数量

Body参数:

返回参数:

参数 类型 说明
errcode int32 返回码
errmsg string 对返回码的文本描述内容
total int32 总数
user_list 列表
user_list.userid string 用户ID
user_list.name string 名称
user_list.mobile string 手机号, 已脱敏
user_list.user_number string 职工号
user_list.corpid string 机构id

请求示例:

GET https://oapi.epaas.qq.com/auth/role/users?access_token=ACCESS_TOKEN&app_role_id=3&keyword=&page_index=1&page_size=30

请求包体:

返回包体:

{
    "errmsg": "ok",
    "errcode": 0,
    "total": 1,
    "user_list": [
        {
            "userid": "3730526139",
            "name": "陶敏一九九的账号",
            "mobile": "199****5200",
            "department_id": 0,
            "user_number": "12312312412312",
            "corpid": "1009697"
        }
    ]
}
© 1998 - 2021 Tencent Inc. All Rights Reserved all right reserved,powered by ePaaS.更新时间: 2024-03-04 10:24:47

results matching ""

    No results matching ""

    results matching ""

      No results matching ""