主要使用場(chǎng)景:用戶信息接口7.0
根據(jù)手機(jī)號(hào)獲取用戶信息
獲取接口訪問(wèn)憑證:accessToken
url | https://api.tze.cn/user/openapi/user/get-user-info-by-phone?accessToken={{accessToken}} |
請(qǐng)求方式 | post |
是否需要鑒權(quán) | 是 |
請(qǐng)求數(shù)限制 | 否 |
接口方向 | 第三方應(yīng)用->開(kāi)放平臺(tái) |
序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說(shuō)明 |
---|---|---|---|---|---|
1 |
phone |
必選 |
string |
用戶手機(jī)號(hào) |
序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說(shuō)明 |
---|---|---|---|---|---|
1 |
code |
必選 |
string |
結(jié)果編碼 | |
2 |
message |
必選 |
string |
結(jié)果描述 | |
3 |
result |
必選 |
json |
結(jié)果對(duì)象 | |
3.1 |
user_id |
必選 |
string |
用戶編號(hào) | |
3.2 |
platform_code |
必選 |
string |
平臺(tái)編號(hào) | |
3.3 |
v_platform_code |
必選 |
string |
虛擬平臺(tái)編號(hào)(多值用逗號(hào)分隔) | |
3.4 |
name |
必選 |
string |
用戶姓名 | |
3.5 |
gender |
必選 |
int |
性別(0:女,1:男,2:未填,3:保密) | |
3.6 |
birthdate |
必選 |
string |
出生日期 | |
3.7 |
status |
必選 |
int |
狀態(tài)(0:未激活, 1:正常, 2:注銷, 3:鎖定, 4:安管鎖定) | |
3.8 |
province_code |
必選 |
string |
所在省 | |
3.9 |
city_code |
必選 |
string |
所在市 | |
3.10 |
area_code |
必選 |
string |
所在區(qū) | |
3.11 |
user_family |
必選 |
json數(shù)組 |
用戶家庭關(guān)系(識(shí)別init_user_type等于0是學(xué)生, 或識(shí)別user_top_org里的user_type等于0是學(xué)生,反之user_family不為空的就是家長(zhǎng),) | |
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 |
綁定的家庭關(guān)系(正數(shù)時(shí):被綁定的是家長(zhǎng),負(fù)數(shù)時(shí):被綁定的是學(xué)生) | |
3.12 |
user_org |
必選 |
json數(shù)組 |
用戶所屬部門(mén)、班級(jí)等節(jié)點(diǎn) | |
3.12.1 |
org_id |
必選 |
string |
用戶所屬部門(mén)、班級(jí)等節(jié)點(diǎn)id | |
3.12.2 |
top_org_id |
必選 |
string |
部門(mén)、班級(jí)所屬的機(jī)構(gòu)、學(xué)校id | |
3.12.3 |
org_type |
必選 |
string |
節(jié)點(diǎn)類型,區(qū)分出部門(mén)、班級(jí)等("1": "機(jī)構(gòu)","2": "學(xué)校","3": "校區(qū)","4": "部門(mén)","5": "學(xué)段","6": "年級(jí)","7": "班級(jí)","8": "企業(yè)機(jī)構(gòu)","9": "教學(xué)工作室","10": "平臺(tái)") | |
3.12.4 |
attr |
必選 |
json數(shù)組 |
用戶在部門(mén)、班級(jí)等節(jié)點(diǎn)里的獨(dú)立屬性數(shù)據(jù)(例如class_teacher_subject教師班級(jí)任教學(xué)科信息、class_header_teacher班級(jí)班主任標(biāo)識(shí)、class_monitor_student班級(jí)班長(zhǎng)標(biāo)識(shí)) | |
3.12.5 |
createtime |
必選 |
int |
用戶加入部門(mén)、班級(jí)等節(jié)點(diǎn)時(shí)間戳 | |
3.12.6 |
updatetime |
必選 |
int |
用戶在部門(mén)、班級(jí)等節(jié)點(diǎn)發(fā)生數(shù)據(jù)更新的時(shí)間戳 | |
3.12.7 |
org_name |
必選 |
string |
用戶所在部門(mén)、班級(jí)等節(jié)點(diǎn)名稱 | |
3.12.8 |
top_org_name |
必選 |
string |
用戶所在機(jī)構(gòu)、學(xué)校的名稱 | |
3.12.9 |
top_school_id |
可選 |
string |
僅在當(dāng)前節(jié)點(diǎn)是校區(qū)、學(xué)段、年級(jí)、班級(jí)時(shí)返回所在的校區(qū)id | |
3.12.10 |
top_school_name |
可選 |
string |
僅在當(dāng)前節(jié)點(diǎn)是校區(qū)、學(xué)段、年級(jí)、班級(jí)時(shí)返回所在的校區(qū)名稱 | |
3.13 |
user_top_org |
必選 |
json數(shù)組 |
用戶所屬機(jī)構(gòu)、學(xué)校等組織 | |
3.13.1 |
attr |
可選 |
json數(shù)組 |
廢棄,返回空數(shù)據(jù) | |
3.13.2 |
name |
必選 |
string |
用戶在所屬組織里的名稱 | |
3.13.3 |
org_type |
必選 |
string |
節(jié)點(diǎn)類型,區(qū)分出部門(mén)、班級(jí)等("1": "機(jī)構(gòu)","2": "學(xué)校","3": "校區(qū)","4": "部門(mén)","5": "學(xué)段","6": "年級(jí)","7": "班級(jí)","8": "企業(yè)機(jī)構(gòu)","9": "教學(xué)工作室","10": "平臺(tái)") | |
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數(shù)組 |
用戶權(quán)限或用戶崗位信息 1、主管理員,查找user_role下top_org_id=組織id,且parent_id=1. 2、子管理員,查找user_role下top_org_id=組織id,且parent_id=2. 2.1、管理范圍判斷:查找power_name=sub_manager_department,且power_value包含all或者部門(mén)id 2.2、基礎(chǔ)權(quán)限判斷:查找power_name=sub_manager_app,且power_value包含all或者基礎(chǔ)權(quán)限id 2.3、應(yīng)用權(quán)限判斷:查找power_name=sub_manager_campus,且power_value包含all或者應(yīng)用id | |
3.14.1 |
parent_id |
必選 |
string |
當(dāng)值為數(shù)字類型時(shí),表示平臺(tái)系統(tǒng)設(shè)置的默認(rèn)角色,如1為主管理員,2為子管理員,更多默認(rèn)角色列表參考獲取默認(rèn)角色接口 當(dāng)值為字符串類型時(shí),表示組織內(nèi)自定義崗位,如 后勤管理 等,若想取得自定義崗位名稱,可使用下面的role_id信息,通過(guò)獲取角色詳情接口獲取 | |
3.14.2 |
role_id |
必選 |
string |
自定義角色/崗位id | |
3.14.3 |
top_org_id |
必選 |
string |
角色/崗位所屬機(jī)構(gòu)、學(xué)校等組織id | |
3.14.4 |
org_id |
必選 |
string |
角色/崗位所屬部門(mén)id | |
3.14.5 |
role_type |
必選 |
string |
角色/崗位類型,0系統(tǒng),1普通,2自定義,廢棄 | |
3.14.6 |
_power |
必選 |
json數(shù)組 |
子管理員權(quán)限信息,包含部門(mén)管理范圍、基礎(chǔ)權(quán)限、應(yīng)用權(quán)限三個(gè)部分 | |
3.14.6.1 |
power_name |
必選 |
string |
權(quán)限類型 1、sub_manager_department:部門(mén)管理范圍,如全學(xué)校、所在部門(mén)等 2、sub_manager_app:基礎(chǔ)權(quán)限,將在以上部門(mén)管理范圍配置權(quán)限,如成員管理、設(shè)置管理 3、sub_manager_campus:應(yīng)用權(quán)限 |
|
3.14.6.2 |
power_value |
必選 |
數(shù)組 |
權(quán)限值,與power_name關(guān)聯(lián)。"all"表示全部權(quán)限,其他權(quán)限對(duì)應(yīng)如下: 1、power_name為sub_manager_department表示部門(mén)管理范圍。power_value取值,all:全學(xué)校,dep:所在部門(mén)及下級(jí)部門(mén),部門(mén)ids:多個(gè)部門(mén)id逗號(hào)分隔,表示管理特定部門(mén) 2、power_name為sub_manager_app表示基礎(chǔ)權(quán)限。power_value取值,1:成員管理,6:組織管理,7:班級(jí)管理,3:工作臺(tái)管理,4:設(shè)置,5:門(mén)戶管理,8:資源庫(kù)管理,9:數(shù)據(jù)管理,10:權(quán)限管理,11:數(shù)據(jù)上報(bào) 3、power_name為sub_manager_campus表示應(yīng)用權(quán)限,power_value取值參照獲取機(jī)構(gòu)權(quán)限應(yīng)用列表接口 |
|
3.15 |
avatar |
必選 |
json |
用戶頭像(1:小, 2:中, 3:大) | |
3.16 |
last_top_org_id |
必選 |
string |
最后切換的機(jī)構(gòu)、學(xué)校等組織編號(hào) | |
3.17 |
last_top_org_name |
必選 |
string |
最后切換的機(jī)構(gòu)、學(xué)校等組織名稱 | |
3.18 |
last_user_type |
必選 |
int |
最后所屬的用戶類型 | |
3.19 |
init_user_type |
必選 |
int |
用戶初始注冊(cè)用戶類型(0學(xué)生,1老師,2家長(zhǎng)等等) | |
3.20 |
init_v_platform_code |
必選 |
string |
用戶初始虛擬平碼編碼 | |
3.21 |
card_type |
必選 |
int |
用戶證件類型,默認(rèn)身份證(0:身份證,1:護(hù)照,6:港澳居民來(lái)往內(nèi)地通行證(香港)/身份證明,7:港澳居民來(lái)往內(nèi)地通行證(澳門(mén))/身份證明,8:臺(tái)灣居民來(lái)往大陸通行證,9:外國(guó)人永久居留證) | |
3.22 |
account |
必選 |
string |
賬號(hào)脫敏 | |
3.23 |
phone |
必選 |
string |
手機(jī)號(hào)脫敏 |
**請(qǐng)求示例** { "phone": "13300000000" } **返回示例** { "code": "000000", "message": "請(qǐng)求成功", "result": { "user_id": "24f5728a-5ff8-11e9-a457-0200f7efd26a", "platform_code": "888888", "v_platform_code": "888888,420100", "name": "lm650730", "gender": "2", "birthdate": "0", "status": "1", "province_code": "", "city_code": "", "area_code": "", "user_family": [], "user_org": [ { "org_id": "0086516a-5ffa-11e9-8d9d-0200f7413ea8", "top_org_id": "42675838-5ff8-11e9-b985-0200f7efd26a", "org_type": "4",//加入了學(xué)校的其中一個(gè)部門(mén) "display_order": "0", "attr": [], "createtime": "1555394037", "updatetime": "1555394037", "org_name": "財(cái)務(wù)部二層", "top_org_name": "武漢小學(xué)" }, { "org_id": "0d1975a8-718c-11e9-9037-0200f7ae226a", "top_org_id": "0d1975a8-718c-11e9-9037-0200f7ae226a", "org_type": "1",//當(dāng)前為機(jī)構(gòu) "display_order": "0", "attr": [], "createtime": "1557318193", "updatetime": "1557318193", "org_name": "武漢市教育局", "top_org_name": "武漢市教育局" }, { "org_id": "42675838-5ff8-11e9-b985-0200f7efd26a", "top_org_id": "42675838-5ff8-11e9-b985-0200f7efd26a", "org_type": "2",//當(dāng)前為學(xué)校 "display_order": "0", "attr": [], "createtime": "1555385548", "updatetime": "1555385548", "org_name": "武漢小學(xué)", "top_org_name": "武漢小學(xué)" }, { "org_id": "bb6c8a0a-6025-11e9-9789-0200f707c8ba", "top_org_id": "42675838-5ff8-11e9-b985-0200f7efd26a", "org_type": "7",//當(dāng)前為班級(jí) "display_order": "0", "attr": [ "class_monitor_student":1,//當(dāng)為班級(jí)學(xué)生時(shí),識(shí)別是否為班級(jí)班長(zhǎng) "class_teacher_subject": [ { "subject_id": "SUB7",//當(dāng)為班級(jí)教師時(shí),學(xué)科id "subject_type": 1,//學(xué)科類型,1基礎(chǔ)學(xué)科,2自定義學(xué)科 "school_period": 2//學(xué)科學(xué)段 }, { "subject_id": "SUB49", "subject_type": 1, "school_period": 2 } ], "class_header_teacher":1//當(dāng)為班級(jí)教師時(shí),識(shí)別是否為班主任 ], "createtime": "1555553403", "updatetime": "1555553403", "top_school_id": "339e6d64-6016-11e9-b89e-0200f74d872f", "org_name": "五年級(jí)2班", "top_org_name": "武漢小學(xué)", "top_school_name": "武漢小學(xué)武昌校區(qū)" } ], "user_top_org": [ { "org_id": "0d1975a8-718c-11e9-9037-0200f7ae226a", "top_org_id": "0d1975a8-718c-11e9-9037-0200f7ae226a", "org_type": "1",//加入了機(jī)構(gòu) "display_order": "1557318193", "name": "lm650730", "user_type": "4", "attr": [], "createtime": "1557318193", "updatetime": "1557318193", "org_name": "武漢市教育局", "top_org_name": "武漢市教育局" }, { "org_id": "42675838-5ff8-11e9-b985-0200f7efd26a", "top_org_id": "42675838-5ff8-11e9-b985-0200f7efd26a", "org_type": "2",//同時(shí)加入了學(xué)校 "display_order": "1555385548", "name": "夏冰888", "user_type": "1", "attr": [], "createtime": "1555385548", "updatetime": "1557453305", "org_name": "武漢小學(xué)", "top_org_name": "武漢小學(xué)" } ], "user_role": [ { "role_id": "26f15578-656f-11e9-b4c2-0200f7a4f10e", "parent_id": "2", "role_type": "2", "org_id": "d040453c-656d-11e9-bbe9-0200f7a4f10e", "top_org_id": "d040453c-656d-11e9-bbe9-0200f7a4f10e", "createtime": "1555986367", "updatetime": "1555986367", "display_order": "0", "_power": [ { "power_name":"sub_manager_department", "power_value":"["all"]", "role_id":"26f15578-656f-11e9-b4c2-0200f7a4f10e", "createtime": "1555986367", "updatetime": "1555986367", }, { "power_name":"sub_manager_app", "power_value":"["1", "4"]", "role_id":"26f15578-656f-11e9-b4c2-0200f7a4f10e", "createtime": "1555986367", "updatetime": "1555986367", }, { "power_name":"sub_manager_campus", "power_value":"["56DEB663D6091A6C4BD329E3696D52DE"]", "role_id":"26f15578-656f-11e9-b4c2-0200f7a4f10e", "createtime": "1555986367", "updatetime": "1555986367", } ] }, { "role_id": "6e0f54fe-600c-11e9-8492-0200f734321a", "parent_id": "3", "role_type": "2", "org_id": "fad2bf4c-5ff9-11e9-84b3-0200f7413ea8", "top_org_id": "42675838-5ff8-11e9-b985-0200f7efd26a", "createtime": "1555394211", "updatetime": "1555394211", "display_order": "0", "_power": [ ] }, { "role_id": "f9e4f920-600c-11e9-9d09-0200f734321a", "parent_id": "ba56b1f4-600c-11e9-a949-0200f734321a", "role_type": "2", "org_id": "42675838-5ff8-11e9-b985-0200f7efd26a", "top_org_id": "42675838-5ff8-11e9-b985-0200f7efd26a", "createtime": "1555394445", "updatetime": "1555395687", "display_order": "0", "_power": [] }, { "role_id": "b8f079f4-600b-11e9-a76c-0200f786b57b", "parent_id": "3", "role_type": "2", "org_id": "42675838-5ff8-11e9-b985-0200f7efd26a", "top_org_id": "42675838-5ff8-11e9-b985-0200f7efd26a", "createtime": "1555393907", "updatetime": "1557317605", "display_order": "0", "_power": [] }, { "role_id": "b0fa88ba-6a70-11e9-bf75-0200f734fe75", "parent_id": "2", "role_type": "2", "org_id": "42675838-5ff8-11e9-b985-0200f7efd26a", "top_org_id": "42675838-5ff8-11e9-b985-0200f7efd26a", "createtime": "1556536784", "updatetime": "1556536784", "display_order": "0", "_power": [ { "id": "b120af54-6a70-11e9-bf75-0200f734fe75", "role_id": "b0fa88ba-6a70-11e9-bf75-0200f734fe75", "power_name": "sub_manager_app", "power_value": "[\"all\"]", "createtime": "1556536784", "updatetime": "1556536784" }, { "id": "b11d9986-6a70-11e9-bf75-0200f734fe75", "role_id": "b0fa88ba-6a70-11e9-bf75-0200f734fe75", "power_name": "sub_manager_department", "power_value": "[\"all\"]", "createtime": "1556536784", "updatetime": "1556536784" } ] } ], "last_top_org_id": "42675838-5ff8-11e9-b985-0200f7efd26a", "last_top_org_name": "武漢小學(xué)", "last_user_type": "1", "init_user_type": "1", "init_v_platform_code": "888880", "account": "a******d32", "phone": "133****8987", } }
序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說(shuō)明 |
---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型,此時(shí)固定為:text |
1.1 |
text |
必選 |
Json |
- |
text消息體 |
1.1.1 |
content |
必選 |
String |
消息內(nèi)容 |
{ "msgtype": "text", "text": { "content": "zhxy msg text test 12" } }
序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說(shuō)明 |
---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型,此時(shí)固定為:link |
2 |
link |
必選 |
Json |
- |
link消息體 |
2.1 |
pcUrl |
必選 |
String |
PC端消息點(diǎn)擊鏈接地址 |
|
2.2 |
appUrl |
必選 |
String |
移動(dòng)客戶端點(diǎn)擊消息時(shí)跳轉(zhuǎn)到的H5地址 |
|
2.3 |
title |
必選 |
String |
消息標(biāo)題 |
|
2.4 |
busiId |
必選 |
String |
對(duì)應(yīng)業(yè)務(wù)的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" } }
序號(hào) | 字段名 | 約束 | 類型 | 長(zhǎng)度 | 說(shuō)明 |
---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型,此時(shí)固定為:oa |
2 |
busiId |
必選 |
String |
- |
該條oa消息在業(yè)務(wù)系統(tǒng)對(duì)應(yīng)的id |
3 |
pcUrl |
必選 |
String |
消息點(diǎn)擊鏈接地址 |
|
4 |
appUrl |
必選 |
String |
移動(dòng)客戶端點(diǎn)擊消息時(shí)跳轉(zhuǎn)到的H5地址 |
|
5 |
oa |
必選 |
Json |
- |
oa類型消息體 |
5.1 |
head |
必選 |
Json |
255 |
消息頭部Json |
5.1.1 |
text |
必選 |
String |
255 |
消息的頭部標(biāo)題 |
5.1.2 |
bgColor |
可選 |
String |
消息頭部的背景顏色。長(zhǎng)度限制為8個(gè)英文字符,其中前2為表示透明度,后6位表示顏色值。不要添加0x。默認(rèn)值:FFCC0000 |
|
5.2 |
body |
可選 |
Json |
消息體 |
|
5.2.1 |
title |
可選 |
String |
消息體的標(biāo)題 |
|
5.2.2 |
content |
可選 |
String |
消息體的正文 |
|
5.2.3 |
imageUrl |
可選 |
String |
消息體中的圖片url |
|
5.2.4 |
fileCount |
可選 |
String |
自定義的附件數(shù)目。此數(shù)字僅供顯示,不作驗(yàn)證 |
|
5.2.5 |
author |
可選 |
String |
自定義的作者名字 |
|
5.2.6 |
form |
可選 |
Json數(shù)組 |
消息體的表單,最多6個(gè) |
|
5.2.7 |
key |
可選 |
String |
消息體的關(guān)鍵字 |
|
5.2.8 |
value |
可選 |
String |
消息體的關(guān)鍵字對(duì)應(yīng)的值 |