教育号->企业微信
部门映射关系
使用场景: 批量根据教育号部门ID(department_id)查询对应的企业微信ID。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 | - |
请求方式: POST(HTTPS)
请求地址: https://oapi.epaas.qq.com/department/qywechat/get_qywechat_ids?access_token=ACCESS_TOKEN
请求包体:
{
"department_ids": [
30009907,
30009906
]
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
department_ids | 是 | 教育号部门ID列表 |
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"qywechat_ids": [
{
"department_id": 30009907,
"qywechat_id": "xxxx"
}
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
qywechat_ids | 部门映射列表 |
qywechat_ids.department_id | 教育号部门ID |
qywechat_ids.qywechat_id | 企业微信部门ID |
用户映射关系
使用场景: 根据userid查询用户企业微信ID。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 | - |
请求方式: POST(HTTPS)
请求地址: https://oapi.epaas.qq.com/user/qywechat/get_qywechat_ids?access_token=ACCESS_TOKEN
请求包体:
{
"userids": [
30009907,
30009906
]
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
userids | 是 | 教育号用户ID 列表 |
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"qywechat_ids": [
{
"userid": 30009907,
"qywechat_id": "xxxx"
}
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
qywechat_ids | 用户映射列表 |
qywechat_ids.userid | 教育号用户ID,在机构内唯一 |
qywechat_ids.qywechat_id | 企业微信用户ID |
企业微信->教育号
部门映射关系
使用场景: 批量根据企业微信ID查询对应的教育号部门ID。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 | - |
请求方式: POST(HTTPS)
请求地址: https://oapi.epaas.qq.com/department/qywechat/get_department_ids?access_token=ACCESS_TOKEN
请求包体:
{
"qywechat_ids": [
30009907,
30009906
],
"qywechat_department_type": 1
}
参数说明: 机构ID和部门ID一致时,表示企业微信部门映射到机构
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
qywechat_ids | 是 | 企业微信部门ID列表 |
qywechat_department_type | 否 | 通讯录类型,不传则查询所有类型。1:内部通讯录;2:家校通讯录 |
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"department_infos": [
{
"qywechat_id": 30009907,
"departments": [
{
"department_id": 40009907,
"corpid": 40009907,
"qywechat_department_type": 1
}
]
}
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
department_infos | 部门映射列表 |
department_infos.departments | 部门信息列表;数据不存在则返回空数组 |
department_infos.departments.department_id | 教育号部门ID |
department_infos.departments.corpid | 机构ID;部门ID为0时,表示企业微信部门映射到机构 |
department_infos.departments.qywechat_department_type | 部门通讯录类型。1:内部通讯录;2:家校通讯录 |
department_infos.qywechat_id | 企业微信部门ID |
用户映射关系
使用场景: 企业微信userid换教育号userid
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 | - |
请求方式: POST(HTTPS)
请求地址: https://oapi.epaas.qq.com/user/qywechat/get_user_ids?access_token=ACCESS_TOKEN
请求包体:
{
"qywechat_ids":[
"SC_phone_1d21934867211600",
"SC_1d2195ecca211600",
"SC_phone_1d21963fcb211600",
"isNotExistQyWeChatId"
]
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
qywechat_ids | 是 | 企业微信用户ID列表 |
返回结果:
注意:如果查询的企业微信用户ID不存在,则对应返回的 userInfos 为空数组
{
"errmsg": "ok",
"errcode": 0,
"usersInfos": [
{
"qywechat_id": "SC_1d2195ecca211600",
"userInfos": [
{
"corpid": 100001,
"userid": "30048601",
"role_id": 11
}
]
},
{
"qywechat_id": "SC_phone_1d21934867211600",
"userInfos": [
{
"corpid": 100002,
"userid": "30048600",
"role_id": 12
}
]
},
{
"qywechat_id": "SC_phone_1d21963fcb211600",
"userInfos": [
{
"corpid": 100003,
"userid": "30048602",
"role_id": 13
}
]
},
{
"qywechat_id": "isNotExistQyWeChatId",
"userInfos": []
}
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
usersInfos | 用户映射列表 |
usersInfos.qywechat_id | 企业微信用户ID |
usersInfos.userInfos | 教育号用户信息列表(一个企业微信ID对应多个教育号用户) |
usersInfos.userInfos.corpid | 教育号机构ID |
usersInfos.userInfos.userid | 教育号用户ID,在机构内唯一 |
usersInfos.userInfos.role_id | 教育号用户角色id, 参考角色类型 |
机构映射关系
使用场景: 获取企业微信明文corpid
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | |
机构凭证 | 支持 |
请求方式: GET(HTTPS)
请求地址: https://oapi.epaas.qq.com/user/qywechat/get_qywx_corpid?access_token=ACCESS_TOKEN
请求参数:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
返回参数:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
qywx_corpid | 企业微信明文corpid |
返回示例:
{
"errmsg": "ok",
"errcode": 0,
"qywx_corpid": "corpid"
}