接口文档实例

iPad会议系统APIV1.0iPad会议系统APIV1.0第1页，共18页回首页注：1、接口URL采用：域+API版本号+资源类+接口名+参数。2、以返回结果示例为准，返回结果字段说明只对部分不清晰的字段作出说明。3、因为客户端是手机，数据载体用轻便的JSON格式。一、API概览用户接口PPT接口聊天接口名片接口通知接口二、API说明1用户接口读取接口user/register_optional_read读取系统注册可选信息项user/read_info通过uid获取用户所有信息写入接口user/register_required_info写入注册必填信息user/register_optional_info写入注册可选填写信息2PPT接口读取接口ppt/items读取本次会议所有要演示的PPTppt/current_state读取当前PPT的状态3聊天接口写入接口chat/update发送一条公共信息chat/private_update根据friend_id发送一条私聊信息读取接口chat/read根据mid读取未读公共信息iPad会议系统APIV1.0iPad会议系统APIV1.0第2页，共18页回首页3聊天接口chat/private_read根据private_mid获取未读私聊信息4名片接口读取接口card/user_list获取所有用户列表card/f_info根据uid获取朋友信息card/invit获取当前用户未读被邀请信息写入接口card/get_request发送交换名片请求card/confirm确认是否分享名片给请求者5通知接口读取接口notification/meeting_info获取本次会议信息notification/survey_read获取现场调查题目notification/polling轮询写入接口notification/suggest反馈建议notification/survey_write提交现场调查答案iPad会议系统APIV1.0iPad会议系统APIV1.0第3页，共18页回首页三、API详情1.11/user/register_optional_read读取系统注册可选信息项URL支持格式JSONHTTP请求方式GET请求参数必选类型及范围说明返回结果示例{“result”:1,“count”:2,“content”:[“邮箱”,“年龄”,...iPad会议系统APIV1.0iPad会议系统APIV1.0第4页，共18页回首页]}字段说明返回值字段字段类型字段说明resultint1:成功0:失败countint注册可选项个数contentarray注册可选项内容1.21/user/read_info通过uid获取用户所有信息URL支持格式JSONHTTP请求方式GET请求参数必选类型及范围说明uid1int64用户uidiPad会议系统APIV1.0iPad会议系统APIV1.0第5页，共18页回首页返回结果示例{“result”:1,“uid”:“001”,“count”:4,“user_info”:{“姓名”:“小王”,“手机号”:“13111111111”,“邮箱”:“[e-mail]”,“年龄”:“”...}}字段说明返回值字段字段类型字段说明resultint1:成功0:失败uidint64当前用户的idcountint用户信息数量（包含用户未填项）user_infoobject用户信息（包含用户未填项，未填返回空string）iPad会议系统APIV1.0iPad会议系统APIV1.0第6页，共18页回首页1.31/user/register_required_info写入注册必填信息URL支持格式JSONHTTP请求方式GET请求参数必选类型及范围说明user_name1string用户姓名user_phone_number1string用户手机号码iPad会议系统APIV1.0iPad会议系统APIV1.0第7页，共18页回首页返回结果示例{“result”:1,“uid”:001,“user_name”:“小王”,“user_phone_number”:“13111111111”}字段说明返回值字段字段类型字段说明resultint1:成功0:失败uidint64当前用户唯一标识符user_namestring用户姓名user_phone_numberstring用户手机号码iPad会议系统APIV1.0iPad会议系统APIV1.0第8页，共18页回首页1.41/user/register_optional_info写入注册可选填写信息URL支持格式JSONHTTP请求方式POST请求参数必选类型及范围说明uid1int64用户idiPad会议系统APIV1.0iPad会议系统APIV1.0第9页，共18页回首页必选类型及范围说明user_email0string用户邮箱user_age0string用户年龄...0string...返回结果示例{“result”:1,“uid”:“001”,“count”:4,“user_info”:{“姓名”:“小王”,“手机号”:“13111111111”,“邮箱”:“[e-mail]”,“年龄”:“18”...}}字段说明返回值字段字段类型字段说明resultint1:成功0:失败iPad会议系统APIV1.0iPad会议系统APIV1.0第10页，共18页回首页返回值字段字段类型字段说明uidint64当前用户的idcountint用户信息数量（包含用户未填项）user_infoobject用户信息（包含用户未填项，未填返回空string）2.11/ppt/items读取本次会议所有要演示的PPTURL支持格式JSONHTTP请求方式GETiPad会议系统APIV1.0iPad会议系统APIV1.0第11页，共18页回首页请求参数必选类型及范围说明返回结果示例{“result”:1,“count”:2,“ppt_items”:[{“ppt_id”:001,“ppt_title”:“演讲一”,“ppt_author”:“小李”,“ppt_pages”:20},{“ppt_id”:002,“ppt_title”:“演讲二”,“ppt_author”:“小刘”,“ppt_pages”:17iPad会议系统APIV1.0iPad会议系统APIV1.0第12页，共18页回首页},...]}字段说明返回值字段字段类型字段说明resultint1:成功0:失败countint本次会议演讲PPT的个数ppt_itemsarrayPPT项目内容ppt_idintPPT的idppt_titlestringPPT的题目ppt_authorstring此PPT演讲者ppt_pagesint此PPT的总页数2.21/ppt/current_state读取当前PPT的状态URL支持格式JSONiPad会议系统APIV1.0iPad会议系统APIV1.0第13页，共18页回首页HTTP请求方式GET请求参数必选类型及范围说明返回结果示例{“result”:1,“ppt_id”:001,“ppt_pages”:20,“ppt_pages_current”:3,“ppt_syn”:1,“ppt_full_screen”:0}字段说明iPad会议系统APIV1.0iPad会议系统APIV1.0第14页，共18页回首页返回值字段字段类型字段说明resultint1:成功0:失败ppt_idintPPT的idppt_pagesint当前PPT的总页数ppt_pages_currentint当前PPT的页码ppt_synint当前PPT是否同步演讲（1：同步0：不同步）ppt_full_screenint当前PPT是否全屏显示（1：全屏0：不全屏）3.11/chat/update发送一条公共信息URL支持格式iPad会议系统APIV1.0iPad会议系统APIV1.0第15页，共18页回首页JSONHTTP请求方式POST请求参数必选类型及范围说明uid1int64用户idchat_message1string信息内容返回结果示例{“result”:1,“uid”:001,“mid”:001,“chat_message”:“你好”}字段说明iPad会议系统APIV1.0iPad会议系统APIV1.0第16页，共18页回首页返回值字段字段类型字段说明resultint1:成功0:失败uidint64当前用户唯一标识符midint64信息的唯一标识符chat_messagestring发送的信息内容URL支持格式JSONHTTP请求方式POST请求参数必选类型及范围说明uid1int64用户idfriend_id1int64私聊对象idchat_private_message1string私聊信息内容iPad会议系统APIV1.0iPad会议系统APIV1.0第17页，共18页回首页返回结果示例{“result”:1,“uid”:001,“friend_id”:002,“private_mid”:001,“chat_private_message”:“你好”}字段说明返回值字段字段类型字段说明resultint1:成功0:失败uidint64当前用户唯一标识符friend_idint64私聊对象idprivate_midint64私聊信息的唯一标识符chat_private_messagestring私聊信息内容iPad会议系统APIV1.0iPad会议系统APIV1.0第18页，共18页回首页3.31/chat/read根据mid读取未读公共信息URL支持格式JSONHTTP请求方式GET请求参数必选类型及范围说明uid1int64用户idmid1int64信息id