接口文檔實(shí)例_第1頁
接口文檔實(shí)例_第2頁
接口文檔實(shí)例_第3頁
接口文檔實(shí)例_第4頁
接口文檔實(shí)例_第5頁
已閱讀5頁,還剩13頁未讀 繼續(xù)免費(fèi)閱讀

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進(jìn)行舉報或認(rèn)領(lǐng)

文檔簡介

1、iPad會議系統(tǒng)API V1.0注:1、接口URL采用:域+API版本號+資源類+接口名+參數(shù)。2、以返回結(jié)果示例為準(zhǔn),返回結(jié)果字段說明只對部分不清晰的字段作出說明。3、因?yàn)榭蛻舳耸鞘謾C(jī),數(shù)據(jù)載體用輕便的JSON格式。一、API概覽用戶接口PPT接口聊天接口名片接口通知接口二、API說明1 用戶接口讀取接口user/register_optional_read讀取系統(tǒng)注冊可選信息項user/read_info通過uid獲取用戶所有信息寫入接口user/register_required_info寫入注冊必填信息user/register_optional_info寫入注冊可選填寫信息2 PPT

2、接口讀取接口ppt/items讀取本次會議所有要演示的PPTppt/current_state讀取當(dāng)前PPT的狀態(tài)3 聊天接口寫入接口chat/update發(fā)送一條公共信息chat/private_update根據(jù)friend_id發(fā)送一條私聊信息讀取接口chat/read根據(jù)mid讀取未讀公共信息chat/private_read根據(jù)private_mid獲取未讀私聊信息4 名片接口讀取接口card/user_list獲取所有用戶列表card/f_info根據(jù)uid獲取朋友信息card/invit獲取當(dāng)前用戶未讀被邀請信息寫入接口card/get_request發(fā)送交換名片請求card/co

3、nfirm確認(rèn)是否分享名片給請求者5 通知接口讀取接口notification/meeting_info獲取本次會議信息notification/survey_read獲取現(xiàn)場調(diào)查題目notification/polling輪詢寫入接口notification/suggest反饋建議notification/survey_write提交現(xiàn)場調(diào)查答案三、API詳情1.11/user/register_optional_read 讀取系統(tǒng)注冊可選信息項URL http:/url/1/user/register_optional_read.php支持格式 JSONHTTP請求方式 GET請求參數(shù) 必

4、選類型及范圍說明返回結(jié)果示例 “result” : 1,“count” : 2,“content” : “郵箱”,“年齡”,.字段說明 返回值字段字段類型字段說明resultint1:成功 0:失敗countint注冊可選項個數(shù)contentarray注冊可選項內(nèi)容1.21/user/read_info 通過uid獲取用戶所有信息URL http:/url/1/user/read_info.php支持格式 JSONHTTP請求方式 GET請求參數(shù) 必選類型及范圍說明uid1int64用戶uid返回結(jié)果示例 “result” : 1,“uid” : “001”,“count” : 4,“user

5、_info” : “姓名” : “小王”,“手機(jī)號” : ,“郵箱” : “a”,“年齡” : “”.字段說明 返回值字段字段類型字段說明resultint1:成功 0:失敗uidint64當(dāng)前用戶的idcountint用戶信息數(shù)量(包含用戶未填項)user_infoobject用戶信息(包含用戶未填項,未填返回空string)1.31/user/register_required_info 寫入注冊必填信息URL http:/url/1/user/register_required_info.php支持格式 JSONHTTP請求方式 GET請求參數(shù) 必選類型及范圍說

6、明user_name1string用戶姓名user_phone_number1string用戶手機(jī)號碼返回結(jié)果示例 “result” : 1,“uid” : 001,“user_name” : “小王”,“user_phone_number” : 字段說明 返回值字段字段類型字段說明resultint1:成功 0:失敗uidint64當(dāng)前用戶唯一標(biāo)識符user_namestring用戶姓名user_phone_numberstring用戶手機(jī)號碼1.41/user/register_optional_info 寫入注冊可選填寫信息URL http:/url/1/use

7、r/register_optional_info.php支持格式 JSONHTTP請求方式 POST請求參數(shù) 必選類型及范圍說明uid1int64用戶iduser_email0string用戶郵箱user_age0string用戶年齡.0string.返回結(jié)果示例 “result” : 1,“uid” : “001”,“count” : 4,“user_info” : “姓名” : “小王”,“手機(jī)號” : ,“郵箱” : “a”,“年齡” : “18”.字段說明 返回值字段字段類型字段說明resultint1:成功 0:失敗uidint64當(dāng)前用戶的idcounti

8、nt用戶信息數(shù)量(包含用戶未填項)user_infoobject用戶信息(包含用戶未填項,未填返回空string)2.11/ppt/items 讀取本次會議所有要演示的PPTURL http:/url/1/ppt/items.php支持格式 JSONHTTP請求方式 GET請求參數(shù) 必選類型及范圍說明返回結(jié)果示例 “result” : 1,“count” : 2,“ppt_items” : “ppt_id” : 001,“ppt_title” : “演講一”,“ppt_author” : “小李”,“ppt_pages” : 20,“ppt_id” : 002,“ppt_title” : “演

9、講二”,“ppt_author” : “小劉”,“ppt_pages” : 17,.字段說明 返回值字段字段類型字段說明resultint1:成功 0:失敗countint本次會議演講PPT的個數(shù)ppt_itemsarrayPPT項目內(nèi)容ppt_idintPPT的idppt_titlestringPPT的題目ppt_authorstring此PPT演講者ppt_pagesint此PPT的總頁數(shù)2.21/ppt/current_state 讀取當(dāng)前PPT的狀態(tài)URL http:/url/1/ppt/current_state.php支持格式 JSONHTTP請求方式 GET請求參數(shù) 必選類型及范

10、圍說明返回結(jié)果示例 “result” : 1,“ppt_id” : 001,“ppt_pages” : 20,“ppt_pages_current” : 3,“ppt_syn” : 1,“ppt_full_screen” : 0字段說明 返回值字段字段類型字段說明resultint1:成功 0:失敗ppt_idintPPT的idppt_pagesint當(dāng)前PPT的總頁數(shù)ppt_pages_currentint當(dāng)前PPT的頁碼ppt_synint當(dāng)前PPT是否同步演講(1:同步 0:不同步)ppt_full_screenint當(dāng)前PPT是否全屏顯示(1:全屏 0:不全屏)3.11/chat/up

11、date 發(fā)送一條公共信息URL http:/url/1/chat/update.php支持格式 JSONHTTP請求方式 POST請求參數(shù) 必選類型及范圍說明uid1int64用戶idchat_message1string信息內(nèi)容返回結(jié)果示例 “result” : 1,“uid” : 001,“mid” : 001,“chat_message” : “你好”字段說明 返回值字段字段類型字段說明resultint1:成功 0:失敗uidint64當(dāng)前用戶唯一標(biāo)識符midint64信息的唯一標(biāo)識符chat_messagestring發(fā)送的信息內(nèi)容URL http:/url/1/chat/priv

12、ate_update.php支持格式 JSONHTTP請求方式 POST請求參數(shù) 必選類型及范圍說明uid1int64用戶idfriend_id1int64私聊對象idchat_private_message1string私聊信息內(nèi)容返回結(jié)果示例 “result” : 1,“uid” : 001,“friend_id” : 002,“private_mid” : 001,“chat_private_message” : “你好”字段說明 返回值字段字段類型字段說明resultint1:成功 0:失敗uidint64當(dāng)前用戶唯一標(biāo)識符friend_idint64私聊對象idprivate_midint64私聊信息的

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時也不承擔(dān)用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論