主要使用场景：用户信息接口7.0
根据手机号获取用户信息
获取接口访问凭证：accessToken
| url | http://www.hzjy.edu.cn/api/user/openapi/user/get-user-info-by-phone?accessToken={{accessToken}} |
| 请求方式 | post |
| 是否需要鉴权 | 是 |
| 请求数限制 | 否 |
| 接口方向 | 第三方应用->开放平台 |
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
1 |
phone |
必选 |
string |
用户手机号 |
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
1 |
code |
必选 |
string |
结果编码 | |
2 |
message |
必选 |
string |
结果描述 | |
3 |
result |
必选 |
json |
结果对象 | |
3.1 |
user_id |
必选 |
string |
用户编号 | |
3.2 |
platform_code |
必选 |
string |
平台编号 | |
3.3 |
v_platform_code |
必选 |
string |
虚拟平台编号（多值用逗号分隔） | |
3.4 |
name |
必选 |
string |
用户姓名 | |
3.5 |
gender |
必选 |
int |
性别（0:女，1:男，2:未填，3：保密） | |
3.6 |
birthdate |
必选 |
string |
出生日期 | |
3.7 |
status |
必选 |
int |
状态(0:未激活, 1:正常, 2:注销, 3:锁定, 4:安管锁定) | |
3.8 |
province_code |
必选 |
string |
所在省 | |
3.9 |
city_code |
必选 |
string |
所在市 | |
3.10 |
area_code |
必选 |
string |
所在区 | |
3.11 |
user_family |
必选 |
json数组 |
用户家庭关系(识别init_user_type等于0是学生, 或识别user_top_org里的user_type等于0是学生,反之user_family不为空的就是家长,) | |
3.11.1 |
top_org_id |
必选 |
string |
废弃字段 | |
3.11.2 |
bind_user_id |
必选 |
string |
被绑定的用户id | |
3.11.3 |
relation_name |
必选 |
string |
绑定的称谓 | |
3.11.4 |
relation_type |
必选 |
string |
绑定的家庭关系(正数时:被绑定的是家长，负数时:被绑定的是学生) | |
3.12 |
user_org |
必选 |
json数组 |
用户所属部门、班级等节点 | |
3.12.1 |
org_id |
必选 |
string |
用户所属部门、班级等节点id | |
3.12.2 |
top_org_id |
必选 |
string |
部门、班级所属的机构、学校id | |
3.12.3 |
org_type |
必选 |
string |
节点类型，区分出部门、班级等(\"1\": \"机构\",\"2\": \"学校\",\"3\": \"校区\",\"4\": \"部门\",\"5\": \"学段\",\"6\": \"年级\",\"7\": \"班级\",\"8\": \"企业机构\",\"9\": \"教学工作室\",\"10\": \"平台\") | |
3.12.4 |
attr |
必选 |
json数组 |
用户在部门、班级等节点里的独立属性数据(例如class_teacher_subject教师班级任教学科信息、class_header_teacher班级班主任标识、class_monitor_student班级班长标识) | |
3.12.5 |
createtime |
必选 |
int |
用户加入部门、班级等节点时间戳 | |
3.12.6 |
updatetime |
必选 |
int |
用户在部门、班级等节点发生数据更新的时间戳 | |
3.12.7 |
org_name |
必选 |
string |
用户所在部门、班级等节点名称 | |
3.12.8 |
top_org_name |
必选 |
string |
用户所在机构、学校的名称 | |
3.12.9 |
top_school_id |
可选 |
string |
仅在当前节点是校区、学段、年级、班级时返回所在的校区id | |
3.12.10 |
top_school_name |
可选 |
string |
仅在当前节点是校区、学段、年级、班级时返回所在的校区名称 | |
3.13 |
user_top_org |
必选 |
json数组 |
用户所属机构、学校等组织 | |
3.13.1 |
attr |
可选 |
json数组 |
废弃，返回空数据 | |
3.13.2 |
name |
必选 |
string |
用户在所属组织里的名称 | |
3.13.3 |
org_type |
必选 |
string |
节点类型，区分出部门、班级等(\"1\": \"机构\",\"2\": \"学校\",\"3\": \"校区\",\"4\": \"部门\",\"5\": \"学段\",\"6\": \"年级\",\"7\": \"班级\",\"8\": \"企业机构\",\"9\": \"教学工作室\",\"10\": \"平台\") | |
3.13.4 |
user_type |
必选 |
string |
用户在所属组织的用户类型 | |
3.13.5 |
org_id |
必选 |
string |
用户所属组织的组织id | |
3.13.6 |
top_org_name |
必选 |
string |
用户所属组织的组织名称 | |
3.14 |
user_role |
必选 |
json数组 |
用户权限或用户岗位信息 1、主管理员，查找user_role下top_org_id=组织id，且parent_id=1.\r\n2、子管理员，查找user_role下top_org_id=组织id，且parent_id=2.\r\n2.1、管理范围判断：查找power_name=sub_manager_department，且power_value包含all或者部门id\r\n2.2、基础权限判断：查找power_name=sub_manager_app，且power_value包含all或者基础权限id\r\n2.3、应用权限判断：查找power_name=sub_manager_campus，且power_value包含all或者应用id | |
3.14.1 |
parent_id |
必选 |
string |
当值为数字类型时，表示平台系统设置的默认角色，如1为主管理员，2为子管理员，更多默认角色列表参考获取默认角色接口\r\n当值为字符串类型时，表示组织内自定义岗位，如 后勤管理 等，若想取得自定义岗位名称，可使用下面的role_id信息，通过获取角色详情接口获取 | |
3.14.2 |
role_id |
必选 |
string |
自定义角色/岗位id | |
3.14.3 |
top_org_id |
必选 |
string |
角色/岗位所属机构、学校等组织id | |
3.14.4 |
org_id |
必选 |
string |
角色/岗位所属部门id | |
3.14.5 |
role_type |
必选 |
string |
角色/岗位类型，0系统，1普通，2自定义，废弃 | |
3.14.6 |
_power |
必选 |
json数组 |
子管理员权限信息，包含部门管理范围、基础权限、应用权限三个部分 | |
3.14.6.1 |
power_name |
必选 |
string |
权限类型 1、sub_manager_department：部门管理范围，如全学校、所在部门等 2、sub_manager_app：基础权限，将在以上部门管理范围配置权限，如成员管理、设置管理 3、sub_manager_campus：应用权限 |
|
3.14.6.2 |
power_value |
必选 |
数组 |
权限值，与power_name关联。\"all\"表示全部权限，其他权限对应如下： 1、power_name为sub_manager_department表示部门管理范围。power_value取值，all:全学校，dep:所在部门及下级部门，部门ids：多个部门id逗号分隔，表示管理特定部门 2、power_name为sub_manager_app表示基础权限。power_value取值，1:成员管理，6:组织管理，7:班级管理，3:工作台管理，4:设置,5:门户管理，8:资源库管理，9:数据管理，10:权限管理，11:数据上报 3、power_name为sub_manager_campus表示应用权限，power_value取值参照获取机构权限应用列表接口 |
|
3.15 |
avatar |
必选 |
json |
用户头像（1:小, 2:中, 3:大） | |
3.16 |
last_top_org_id |
必选 |
string |
最后切换的机构、学校等组织编号 | |
3.17 |
last_top_org_name |
必选 |
string |
最后切换的机构、学校等组织名称 | |
3.18 |
last_user_type |
必选 |
int |
最后所属的用户类型 | |
3.19 |
init_user_type |
必选 |
int |
用户初始注册用户类型(0学生，1老师，2家长等等) | |
3.20 |
init_v_platform_code |
必选 |
string |
用户初始虚拟平码编码 | |
3.21 |
card_type |
必选 |
int |
用户证件类型，默认身份证(0:身份证,1:护照,6:港澳居民来往内地通行证（香港）/身份证明,7:港澳居民来往内地通行证（澳门）/身份证明,8:台湾居民来往大陆通行证,9:外国人永久居留证) | |
3.22 |
account |
必选 |
string |
账号脱敏 | |
3.23 |
phone |
必选 |
string |
手机号脱敏 |
**请求示例**\n\n{\n \"phone\": \"13300000000\"\n}\n\n **返回示例**\n\n{\n \"code\": \"000000\",\n \"message\": \"请求成功\",\n \"result\": {\n \"user_id\": \"24f5728a-5ff8-11e9-a457-0200f7efd26a\",\n \"platform_code\": \"888888\",\n \"v_platform_code\": \"888888,420100\",\n \"name\": \"lm650730\",\n \"gender\": \"2\",\n \"birthdate\": \"0\",\n \"status\": \"1\",\n \"province_code\": \"\",\n \"city_code\": \"\",\n \"area_code\": \"\",\n \"user_family\": [],\n \"user_org\": [\n {\n \"org_id\": \"0086516a-5ffa-11e9-8d9d-0200f7413ea8\",\n \"top_org_id\": \"42675838-5ff8-11e9-b985-0200f7efd26a\",\n \"org_type\": \"4\",//加入了学校的其中一个部门\n \"display_order\": \"0\",\n \"attr\": [],\n \"createtime\": \"1555394037\",\n \"updatetime\": \"1555394037\",\n \"org_name\": \"财务部二层\",\n \"top_org_name\": \"武汉小学\"\n },\n {\n \"org_id\": \"0d1975a8-718c-11e9-9037-0200f7ae226a\",\n \"top_org_id\": \"0d1975a8-718c-11e9-9037-0200f7ae226a\",\n \"org_type\": \"1\",//当前为机构\n \"display_order\": \"0\",\n \"attr\": [],\n \"createtime\": \"1557318193\",\n \"updatetime\": \"1557318193\",\n \"org_name\": \"武汉市教育局\",\n \"top_org_name\": \"武汉市教育局\"\n },\n {\n \"org_id\": \"42675838-5ff8-11e9-b985-0200f7efd26a\",\n \"top_org_id\": \"42675838-5ff8-11e9-b985-0200f7efd26a\",\n \"org_type\": \"2\",//当前为学校\n \"display_order\": \"0\",\n \"attr\": [],\n \"createtime\": \"1555385548\",\n \"updatetime\": \"1555385548\",\n \"org_name\": \"武汉小学\",\n \"top_org_name\": \"武汉小学\"\n },\n {\n \"org_id\": \"bb6c8a0a-6025-11e9-9789-0200f707c8ba\",\n \"top_org_id\": \"42675838-5ff8-11e9-b985-0200f7efd26a\",\n \"org_type\": \"7\",//当前为班级\n \"display_order\": \"0\",\n \"attr\": [\n \"class_monitor_student\":1,//当为班级学生时，识别是否为班级班长\n \"class_teacher_subject\": [\n {\n \"subject_id\": \"SUB7\",//当为班级教师时，学科id\n \"subject_type\": 1,//学科类型，1基础学科，2自定义学科\n \"school_period\": 2//学科学段\n },\n {\n \"subject_id\": \"SUB49\",\n \"subject_type\": 1,\n \"school_period\": 2\n }\n ]，\n \"class_header_teacher\":1//当为班级教师时，识别是否为班主任\n ],\n \"createtime\": \"1555553403\",\n \"updatetime\": \"1555553403\",\n \"top_school_id\": \"339e6d64-6016-11e9-b89e-0200f74d872f\",\n \"org_name\": \"五年级2班\",\n \"top_org_name\": \"武汉小学\",\n \"top_school_name\": \"武汉小学武昌校区\"\n }\n ],\n \"user_top_org\": [\n {\n \"org_id\": \"0d1975a8-718c-11e9-9037-0200f7ae226a\",\n \"top_org_id\": \"0d1975a8-718c-11e9-9037-0200f7ae226a\",\n \"org_type\": \"1\",//加入了机构\n \"display_order\": \"1557318193\",\n \"name\": \"lm650730\",\n \"user_type\": \"4\",\n \"attr\": [],\n \"createtime\": \"1557318193\",\n \"updatetime\": \"1557318193\",\n \"org_name\": \"武汉市教育局\",\n \"top_org_name\": \"武汉市教育局\"\n },\n {\n \"org_id\": \"42675838-5ff8-11e9-b985-0200f7efd26a\",\n \"top_org_id\": \"42675838-5ff8-11e9-b985-0200f7efd26a\",\n \"org_type\": \"2\",//同时加入了学校\n \"display_order\": \"1555385548\",\n \"name\": \"夏冰888\",\n \"user_type\": \"1\",\n \"attr\": [],\n \"createtime\": \"1555385548\",\n \"updatetime\": \"1557453305\",\n \"org_name\": \"武汉小学\",\n \"top_org_name\": \"武汉小学\"\n }\n ],\n \"user_role\": [\n {\n \"role_id\": \"26f15578-656f-11e9-b4c2-0200f7a4f10e\",\n \"parent_id\": \"2\",\n \"role_type\": \"2\",\n \"org_id\": \"d040453c-656d-11e9-bbe9-0200f7a4f10e\",\n \"top_org_id\": \"d040453c-656d-11e9-bbe9-0200f7a4f10e\",\n \"createtime\": \"1555986367\",\n \"updatetime\": \"1555986367\",\n \"display_order\": \"0\",\n \"_power\": [\n {\n \"power_name\":\"sub_manager_department\",\n \"power_value\":\"[\"all\"]\",\n \"role_id\":\"26f15578-656f-11e9-b4c2-0200f7a4f10e\",\n \"createtime\": \"1555986367\",\n \"updatetime\": \"1555986367\",\n },\n {\n \"power_name\":\"sub_manager_app\",\n \"power_value\":\"[\"1\", \"4\"]\",\n \"role_id\":\"26f15578-656f-11e9-b4c2-0200f7a4f10e\",\n \"createtime\": \"1555986367\",\n \"updatetime\": \"1555986367\",\n },\n {\n \"power_name\":\"sub_manager_campus\",\n \"power_value\":\"[\"56DEB663D6091A6C4BD329E3696D52DE\"]\",\n \"role_id\":\"26f15578-656f-11e9-b4c2-0200f7a4f10e\",\n \"createtime\": \"1555986367\",\n \"updatetime\": \"1555986367\",\n }\n ]\n },\n {\n \"role_id\": \"6e0f54fe-600c-11e9-8492-0200f734321a\",\n \"parent_id\": \"3\",\n \"role_type\": \"2\",\n \"org_id\": \"fad2bf4c-5ff9-11e9-84b3-0200f7413ea8\",\n \"top_org_id\": \"42675838-5ff8-11e9-b985-0200f7efd26a\",\n \"createtime\": \"1555394211\",\n \"updatetime\": \"1555394211\",\n \"display_order\": \"0\",\n \"_power\": [\n ]\n },\n {\n \"role_id\": \"f9e4f920-600c-11e9-9d09-0200f734321a\",\n \"parent_id\": \"ba56b1f4-600c-11e9-a949-0200f734321a\",\n \"role_type\": \"2\",\n \"org_id\": \"42675838-5ff8-11e9-b985-0200f7efd26a\",\n \"top_org_id\": \"42675838-5ff8-11e9-b985-0200f7efd26a\",\n \"createtime\": \"1555394445\",\n \"updatetime\": \"1555395687\",\n \"display_order\": \"0\",\n \"_power\": []\n },\n {\n \"role_id\": \"b8f079f4-600b-11e9-a76c-0200f786b57b\",\n \"parent_id\": \"3\",\n \"role_type\": \"2\",\n \"org_id\": \"42675838-5ff8-11e9-b985-0200f7efd26a\",\n \"top_org_id\": \"42675838-5ff8-11e9-b985-0200f7efd26a\",\n \"createtime\": \"1555393907\",\n \"updatetime\": \"1557317605\",\n \"display_order\": \"0\",\n \"_power\": []\n },\n {\n \"role_id\": \"b0fa88ba-6a70-11e9-bf75-0200f734fe75\",\n \"parent_id\": \"2\",\n \"role_type\": \"2\",\n \"org_id\": \"42675838-5ff8-11e9-b985-0200f7efd26a\",\n \"top_org_id\": \"42675838-5ff8-11e9-b985-0200f7efd26a\",\n \"createtime\": \"1556536784\",\n \"updatetime\": \"1556536784\",\n \"display_order\": \"0\",\n \"_power\": [\n {\n \"id\": \"b120af54-6a70-11e9-bf75-0200f734fe75\",\n \"role_id\": \"b0fa88ba-6a70-11e9-bf75-0200f734fe75\",\n \"power_name\": \"sub_manager_app\",\n \"power_value\": \"[\\\"all\\\"]\",\n \"createtime\": \"1556536784\",\n \"updatetime\": \"1556536784\"\n },\n {\n \"id\": \"b11d9986-6a70-11e9-bf75-0200f734fe75\",\n \"role_id\": \"b0fa88ba-6a70-11e9-bf75-0200f734fe75\",\n \"power_name\": \"sub_manager_department\",\n \"power_value\": \"[\\\"all\\\"]\",\n \"createtime\": \"1556536784\",\n \"updatetime\": \"1556536784\"\n }\n ]\n }\n ],\n \"last_top_org_id\": \"42675838-5ff8-11e9-b985-0200f7efd26a\",\n \"last_top_org_name\": \"武汉小学\",\n \"last_user_type\": \"1\",\n \"init_user_type\": \"1\",\n \"init_v_platform_code\": \"888880\",\n \"account\": \"a******d32\",\n \"phone\": \"133****8987\",\n }\n}
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型，此时固定为：text |
1.1 |
text |
必选 |
Json |
- |
text消息体 |
1.1.1 |
content |
必选 |
String |
消息内容 |
{
"msgtype": "text",
"text": {
"content": "zhxy msg text test 12"
}
}
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型，此时固定为：link |
2 |
link |
必选 |
Json |
- |
link消息体 |
2.1 |
pcUrl |
必选 |
String |
PC端消息点击链接地址 |
|
2.2 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
2.3 |
title |
必选 |
String |
消息标题 |
|
2.4 |
busiId |
必选 |
String |
对应业务的id |
|
2.5 |
content |
必选 |
String |
消息描述 |
|
2.6 |
picUrl |
必选 |
String |
图文消息的图片链接，支持JPG、PNG格式，较好的效果为大图640*320，小图80*80。如不填，在客户端不显示图片 |
{
"msgtype": "link",
"link": {
"pcUrl": "http://www.baidu.com",
"appUrl": "http://www.baidu.com",
"picUrl": "http://xxx.yyy.com/zzz.jpg",
"content": "百度一下",
"title": "百度",
"busiId":"AQWER1234"
}
}
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型，此时固定为：oa |
2 |
busiId |
必选 |
String |
- |
该条oa消息在业务系统对应的id |
3 |
pcUrl |
必选 |
String |
消息点击链接地址 |
|
4 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
5 |
oa |
必选 |
Json |
- |
oa类型消息体 |
5.1 |
head |
必选 |
Json |
255 |
消息头部Json |
5.1.1 |
text |
必选 |
String |
255 |
消息的头部标题 |
5.1.2 |
bgColor |
可选 |
String |
消息头部的背景颜色。长度限制为8个英文字符，其中前2为表示透明度，后6位表示颜色值。不要添加0x。默认值：FFCC0000 |
|
5.2 |
body |
可选 |
Json |
消息体 |
|
5.2.1 |
title |
可选 |
String |
消息体的标题 |
|
5.2.2 |
content |
可选 |
String |
消息体的正文 |
|
5.2.3 |
imageUrl |
可选 |
String |
消息体中的图片url |
|
5.2.4 |
fileCount |
可选 |
String |
自定义的附件数目。此数字仅供显示，不作验证 |
|
5.2.5 |
author |
可选 |
String |
自定义的作者名字 |
|
5.2.6 |
form |
可选 |
Json数组 |
消息体的表单，最多6个 |
|
5.2.7 |
key |
可选 |
String |
消息体的关键字 |
|
5.2.8 |
value |
可选 |
String |
消息体的关键字对应的值 |
