接口文檔實(shí)例

1、iPad會(huì)議系統(tǒng) API V1.0注：1、接口 URL采用：域+API版本號(hào)+資源類(lèi)+接口名+參數(shù)。2、以返回結(jié)果示例為準(zhǔn)，返回結(jié)果字段說(shuō)明只對(duì)部分不清晰的字段作出說(shuō)明3、因?yàn)榭蛻?hù)端是手機(jī)，數(shù)據(jù)載體用輕便的 JSON格式。一、API概覽用戶(hù)接口PPT 接口聊天接口名片接口通知接口1、API說(shuō)明1用戶(hù)接口讀取接口user/register optional read讀取系統(tǒng)注冊(cè)可選信息項(xiàng)user/read info通過(guò)uid獲取用戶(hù)所有信息寫(xiě)入接口user/register required info寫(xiě)入注冊(cè)必填信息user/register optional info寫(xiě)入注冊(cè)可選填寫(xiě)信息2 P

2、PT 接口讀取接口ppt/items讀取本次會(huì)議所有要演示的PPTppt/current state讀取當(dāng)前PPT的狀態(tài)3聊天接口寫(xiě)入接口chat/update發(fā)送條公共信息chat/private update根據(jù)friend_id發(fā)送一條私聊信息讀取接口chat/read根據(jù)mid讀取未讀公共信息3聊天接口chat/private read根據(jù)private_mid獲取未讀私聊信息4名片接口讀取接口card/user list獲取所有用戶(hù)列表card/f info根據(jù)uid獲取朋友信息card/i nvit獲取當(dāng)前用戶(hù)未讀被邀請(qǐng)信息寫(xiě)入接口card/get request發(fā)送交換名片請(qǐng)求c

3、ard/c onfirm確認(rèn)是否分享名片給請(qǐng)求者5通知接口讀取接口notification/meeting info獲取本次會(huì)議信息no tificati on /survey read獲取現(xiàn)場(chǎng)調(diào)查題目no tificati on/poll ing輪詢(xún)寫(xiě)入接口no tificati on /suggest反饋建議no tificati on /survey write提交現(xiàn)場(chǎng)調(diào)查答案iPad會(huì)議系統(tǒng)API V1.0第3頁(yè)，共18頁(yè) 回首頁(yè)iPad會(huì)議系統(tǒng) API V1.0三、API詳情1.11/user/register_optio nal_read讀取系統(tǒng)注冊(cè)可選信息項(xiàng)URLhttp:/ur

4、l/1/user/register_opti on al_read.php支持格式JSONHTTP請(qǐng)求方式GET請(qǐng)求參數(shù)必選類(lèi)型及范圍說(shuō)明返回結(jié)果示例result ”： 1,“ount ”: 2, “ontent ”:郵箱” 年齡”字段說(shuō)明返回值字段字段類(lèi)型字段說(shuō)明resultint1:成功0:失敗cou ntint注冊(cè)可選項(xiàng)個(gè)數(shù)contentarray注冊(cè)可選項(xiàng)內(nèi)容1.21/user/read _info通過(guò)uid獲取用戶(hù)所有信息URLhttp:/url/1/user/read_info .php支持格式JSONHTTP請(qǐng)求方式GET請(qǐng)求參數(shù)必選類(lèi)型及范圍說(shuō)明uid1in t64用戶(hù)uidi

5、Pad會(huì)議系統(tǒng)API V1.0第5頁(yè)，共18頁(yè) 回首頁(yè)iPad會(huì)議系統(tǒng) API V1.0返回結(jié)果示例result ”： 1,“id ”： 001 ”， Count ” : 4, user_i nfo _姓名”：小王”芋機(jī)號(hào) ”” 郵箱 ”:a ”，字段說(shuō)明返回值字段字段類(lèi) 型字段說(shuō)明resultint1:成功0:失敗uidin t64當(dāng)前用戶(hù)的idcou ntint用戶(hù)信息數(shù)量（包含用戶(hù)未填項(xiàng)）user_i nfoobject用戶(hù)信息（包含用戶(hù)未填項(xiàng)，未填返回空string）1.31/user/register_required _info寫(xiě)入注冊(cè)必填信息URLhtt

6、p:/url/1/user/register_required_i nfo.php支持格式JSONHTTP請(qǐng)求方式GET請(qǐng)求參數(shù)必選類(lèi)型 及范 圍說(shuō)明user_ name1stri ng用戶(hù)姓名user_ph one_nu mber1stri ng用戶(hù)手機(jī)號(hào)碼返回結(jié)果示例result ”： 1,“id ”: 001,a4-f user_name :小王,“ser_phone_number ”： “3111111111 ” 一 一字段說(shuō)明返回值字段字段類(lèi)型字段說(shuō)明resultint1：成功0:失敗uidin t64當(dāng)前用戶(hù)唯一標(biāo)識(shí)符user_ namestri ng用戶(hù)姓名user_ph one

7、_nu mberstri ng用戶(hù)手機(jī)號(hào)碼1.41/user/register_optio nal_i nfo寫(xiě)入注冊(cè)可選填寫(xiě)信息URLhttp:/url/1/user/register_optio nal_in fo.php支持格式JSONHTTP請(qǐng)求方式POST請(qǐng)求參數(shù)必選類(lèi)型 及范 圍說(shuō)明uid1in t64用戶(hù)idiPad會(huì)議系統(tǒng)API V1.0第9頁(yè)，共18頁(yè) 回首頁(yè)iPad會(huì)議系統(tǒng) API V1.0必選類(lèi)型 及范 圍說(shuō)明user_email0stri ng用戶(hù)郵箱user_age0stri ng用戶(hù)年齡.0stri ng返回結(jié)果示例result ”： 1,“id ”： 001 ”，

8、Count ” : 4,user_i nfo _姓名”：小王”芋機(jī)號(hào) ””郵箱 ”:a ”，年齡”：18 ”字段說(shuō)明返回值字段字段類(lèi)型字段說(shuō)明resultint1：成功0：失敗返回值字段字段類(lèi)型字段說(shuō)明uidin t64當(dāng)前用戶(hù)的idcou ntint用戶(hù)信息數(shù)量（包含用戶(hù)未填項(xiàng)）user_i nfoobject用戶(hù)信息（包含用戶(hù)未填項(xiàng)，未填返回空string）2.11/ppt/items讀取本次會(huì)議所有要演示的PPTURLhttp:/url/1/ppt/items.php支持格式JSONHTTP請(qǐng)求方式GETiPad會(huì)議系統(tǒng)API V1.0第12頁(yè)，共18頁(yè) 回首頁(yè)

9、iPad會(huì)議系統(tǒng) API V1.0請(qǐng)求參數(shù)必選類(lèi)型 及范 圍說(shuō)明返回結(jié)果示例result ”： 1,“ount ”: 2,ppt_items ”:_ppt_id ”： 001,ppt_title ”:演講一 ”， ppt_author ”:小李”， ppt_pages ”: 20， 一ppt_id ” : 002, ppt_title ”:演講二”， ppt_author ”: 小劉” ppt_pages ”： 17iPad會(huì)議系統(tǒng)API V1.0第11頁(yè)，共18頁(yè) 回首頁(yè)iPad會(huì)議系統(tǒng) API V1.0,字段說(shuō)明返回值字段字段類(lèi)型字段說(shuō)明resultint1:成功0:失敗cou ntint

10、本次會(huì)議演講PPT的個(gè)數(shù)ppt_itemsarrayPPT項(xiàng)目?jī)?nèi)容ppt_idintPPT 的 idppt_titlestri ngPPT的題目ppt_authorstri ng此PPT演講者ppt_pagesint此PPT的總頁(yè)數(shù)2.21/ppt/curre nt_state讀取當(dāng)前PPT的狀態(tài)URLhttp:/url/1/ppt/curre nt_state.php支持格式JSONHTTP請(qǐng)求方式GET請(qǐng)求參數(shù)必選類(lèi)型 及范 圍說(shuō)明返回結(jié)果示例result ”： 1, ppt_id ”： 001, ppt_pages ”: 20, 0pt_pages_current ”: 3, ppt_s

11、yn ”： 1,”0pt_full_screen ” ： 0 一 一字段說(shuō)明返回值字段字段類(lèi)型字段說(shuō)明resultint1:成功0:失敗ppt_idintPPT 的 idppt_pagesint當(dāng)前PPT的總頁(yè)數(shù)ppt_pages_curre ntint當(dāng)前PPT的頁(yè)碼ppt_synint當(dāng)前PPT是否同步演講（1 :同步0 :不同步）ppt_full_scree nint當(dāng)前PPT是否全屏顯示（1 :全屏0 :不全屏）3.11/chat/update發(fā)送一條公共信息URLhttp:/url/1/chat/update.php支持格式JSONHTTP請(qǐng)求方式POST請(qǐng)求參數(shù)必選類(lèi)型及 范圍說(shuō)明

12、uid1in t64用戶(hù)idchat_message1stri ng信息內(nèi)容返回結(jié)果示例result ”： 1,“id ”: 001, mid ”： 001,Chat_message ”:你好” _字段說(shuō)明返回值字段字段類(lèi)型字段說(shuō)明resultint1:成功0:失敗uidin t64當(dāng)前用戶(hù)唯一標(biāo)識(shí)符midin t64信息的唯一標(biāo)識(shí)符chat_messagestri ng發(fā)送的信息內(nèi)容URLhttp:/url/1/chat/private_update.php支持格式JSONHTTP請(qǐng)求方式POST請(qǐng)求參數(shù)必選類(lèi)型 及范 圍說(shuō)明uid1in t64用戶(hù)idfrie ndd1in t64私聊對(duì)象idchat_private_message1stri ng私聊信息內(nèi)容返回結(jié)果示例result ”： 1,“id ”: 001,friendd ”: 002, private_mid ”: 001,Chat_private_message ”:你好” 一 一字段說(shuō)明返回值字段字段類(lèi)型字段說(shuō)明resultint1:成功0:失敗uidin t64當(dāng)前用戶(hù)唯一標(biāo)識(shí)符frie nddin t64私聊對(duì)象idprivate_midin t64私聊信息的唯標(biāo)識(shí)付chat_private_messagest