主要使用場景:第三方應用接入平臺后,需要與平臺會話保持一致時使用
根據(jù)ticket驗證ticket信息,ticket為一次性調用
獲取接口訪問憑證:accessToken
url | https://api.tze.cn/user/openapi/user/verify-ticket-info?ticket=**&accessToken={{ACCESS_TOKEN}} |
請求方式 | get |
是否需要鑒權 | 是 |
請求數(shù)限制 | 是 |
接口方向 | 第三方應用->開放平臺 |
序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
ticket |
必選 |
String |
64 |
ticket |
序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
code |
必選 |
string |
結果編碼 | |
2 |
message |
必選 |
string |
結果描述 | |
3 |
result |
可選 |
json |
結果對象 | |
3.0 |
usession_id |
必選 |
string |
用戶會話編號 | |
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 |
狀態(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ù)組 |
用戶家庭關系(識別init_user_type等于0是學生, 或識別user_top_org里的user_type等于0是學生,反之user_family不為空的就是家長,) | |
3.11.1 |
bind_user_id |
必選 |
string |
被綁定的用戶id | |
3.11.2 |
relation_name |
必選 |
string |
綁定的稱謂 | |
3.11.3 |
relation_type |
必選 |
string |
綁定的家庭關系(正數(shù)時:被綁定的是家長,負數(shù)時:被綁定的是學生) | |
3.12 |
user_org |
必選 |
json數(shù)組 |
用戶所屬部門、班級等節(jié)點 | |
3.12.1 |
org_id |
必選 |
string |
用戶所屬部門、班級等節(jié)點id | |
3.12.2 |
top_org_id |
必選 |
string |
部門、班級所屬的機構、學校id | |
3.12.3 |
org_type |
必選 |
string |
組織類型("1": "機構","2": "學校","3": "校區(qū)","4": "部門","5": "學段","6": "年級","7": "班級","8": "企業(yè)機構","9": "教學工作室","10": "平臺") | |
3.12.4 |
attr |
必選 |
json數(shù)組 |
用戶在部門、班級等節(jié)點里的獨立屬性數(shù)據(jù)(例如class_teacher_subject教師班級任教學科信息、class_header_teacher班級班主任標識、class_monitor_student班級班長標識) | |
3.12.5 |
org_name |
必選 |
string |
用戶所在部門、班級等節(jié)點名稱 | |
3.12.6 |
top_org_name |
必選 |
string |
用戶所在機構、學校的名稱 | |
3.12.7 |
top_school_id |
可選 |
string |
僅在當前節(jié)點是校區(qū)、學段、年級、班級時返回所在的校區(qū)id | |
3.12.8 |
top_school_name |
可選 |
string |
僅在當前節(jié)點是校區(qū)、學段、年級、班級時返回所在的校區(qū)名稱 | |
3.13 |
user_top_org |
必選 |
json數(shù)組 |
用戶所屬機構、學校等組織 | |
3.13.1 |
name |
必選 |
string |
用戶在所屬組織里的名稱 | |
3.13.2 |
org_type |
必選 |
string |
用戶所屬組織的組織類型("1": "機構","2": "學校","3": "校區(qū)","4": "部門","5": "學段","6": "年級","7": "班級","8": "企業(yè)機構","9": "教學工作室","10": "平臺") | |
3.13.3 |
user_type |
必選 |
string |
用戶在所屬組織的用戶類型 | |
3.13.4 |
org_id |
必選 |
string |
用戶所屬組織的組織id | |
3.13.5 |
top_org_name |
必選 |
string |
用戶所屬組織的組織名稱 | |
3.14 |
user_role |
必選 |
json數(shù)組 |
用戶權限或用戶崗位信息 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或者部門id 2.2、基礎權限判斷:查找power_name=sub_manager_app,且power_value包含all或者基礎權限id 2.3、應用權限判斷:查找power_name=sub_manager_campus,且power_value包含all或者應用id | |
3.14.1 |
parent_id |
必選 |
string |
當值為數(shù)字類型時,表示平臺系統(tǒng)設置的默認角色,如1為主管理員,2為子管理員,更多默認角色列表參考獲取默認角色接口 當值為字符串類型時,表示組織內自定義崗位,如 后勤管理 等,若想取得自定義崗位名稱,可使用下面的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系統(tǒng),1普通,2自定義,廢棄 | |
3.14.6 |
_power |
必選 |
json數(shù)組 |
子管理員權限信息,包含部門管理范圍、基礎權限、應用權限三個部分 | |
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 |
必選 |
數(shù)組 |
權限值,與power_name關聯(lián)。”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:數(shù)據(jù)管理,10:權限管理,11:數(shù)據(jù)上報 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 |
用戶初始虛擬平碼編碼 |
請求示例 http://api.tze.cn/user/openapi/user/verify-ticket-info?ticket=**&accessToken={{ACCESS_TOKEN}} 返回示例 { "code": "000000", "message": "請求成功", "result": { "usession_id": "1291f592-7519-11e9-a1f3-0200f7934077", "xxxx": "xxxx", "yyyy": "yyyy", } }
序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
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 |
對應業(yè)務的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消息在業(yè)務系統(tǒng)對應的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 |
自定義的附件數(shù)目。此數(shù)字僅供顯示,不作驗證 |
|
5.2.5 |
author |
可選 |
String |
自定義的作者名字 |
|
5.2.6 |
form |
可選 |
Json數(shù)組 |
消息體的表單,最多6個 |
|
5.2.7 |
key |
可選 |
String |
消息體的關鍵字 |
|
5.2.8 |
value |
可選 |
String |
消息體的關鍵字對應的值 |