收藏 分享(赏)

接口文档实例.doc

上传人:精品资料 文档编号:9517822 上传时间:2019-08-12 格式:DOC 页数:18 大小:68.65KB
下载 相关 举报
接口文档实例.doc_第1页
第1页 / 共18页
接口文档实例.doc_第2页
第2页 / 共18页
接口文档实例.doc_第3页
第3页 / 共18页
接口文档实例.doc_第4页
第4页 / 共18页
接口文档实例.doc_第5页
第5页 / 共18页
点击查看更多>>
资源描述

1、iPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 1 页,共 18 页 回首页注:1、接口 URL 采用:域+API 版本号+资源类+ 接口名 +参数。2、以返回结 果示例为准,返回 结果字段说明只对部分不清晰的字段作出说明。3、因为客户 端是手机,数据 载体用轻便的 JSON 格式。一、API 概览用户接口 PPT 接口 聊天接口名片接口 通知接口二、API 说明1 用户接口user/register_optional_read 读取系统注册可选信息项读取接口user/read_info 通过 uid 获取用户所有信息user/register_required_

2、info 写入注册必填信息写入接口user/register_optional_info 写入注册可选填写信息2 PPT 接口ppt/items 读取本次会议所有要演示的 PPT读取接口ppt/current_state 读取当前 PPT 的状态3 聊天接口chat/update 发送一条公共信息写入接口chat/private_update 根据 friend_id 发送一条私聊信息iPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 2 页,共 18 页 回首页3 聊天接口chat/read 根据 mid 读取未读公共信息读取接口chat/private_read

3、根据 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 反馈建议写入接口notificatio

4、n/survey_write 提交现场调查答案iPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 3 页,共 18 页 回首页三、API 详情1.11/user/register_optional_read 读取系统注册可选信息项URL http:/url/1/user/register_optional_read.php支持格式 JSONHTTP 请求方式 GET请求参数 必选 类型及范围 说明返回结果示例 “result” : 1,“count” : 2,“content” : iPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 4 页,

5、共 18 页 回首页“邮箱”,“年龄”,.字段说明 返回值字段 字段类型 字段说明result int 1:成功 0:失败count int 注册可选项个数content array 注册可选项内容1.21/user/read_info 通过 uid 获取用户所有信息URL http:/url/1/user/read_info.php支持格式 JSONHTTP 请求方式 GET请求参数 必选 类型及范围 说明uid 1 int64 用户 uidiPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 5 页,共 18 页 回首页返回结果示例 “result” : 1,“ui

6、d” : “001”,“count” : 4,“user_info” : “姓名” : “小王 ”,“手机号” : “13111111111”,“邮箱” : “”,“年龄” : “”.字段说明 返回值字段 字段类型字段说明result int 1:成功 0:失败uid int64 当前用户的 idcount int 用户信息数量(包含用户未填项)user_info object 用户信息(包含用户未填项,未填返回空 string)iPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 6 页,共 18 页 回首页1.31/user/register_required_in

7、fo 写入注册必填信息URL http:/url/1/user/register_required_info.php支持格式 JSONHTTP 请求方式 GET请求参数 必选 类型及 范围 说明user_name 1 string 用户姓名iPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 7 页,共 18 页 回首页必选 类型及 范围 说明user_phone_number 1 string 用户手机号码返回结果示例 “result” : 1,“uid” : 001,“user_name” : “小王”,“user_phone_number” : “13111111

8、111”字段说明 返回值字段 字段类型 字段说明result int 1:成功 0:失败uid int64 当前用户唯一标识符user_name string 用户姓名user_phone_number string 用户手机号码iPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 8 页,共 18 页 回首页1.41/user/register_optional_info 写入注册可选填写信息URL http:/url/1/user/register_optional_info.php支持格式 JSONHTTP 请求方式 POST请求参数 iPad 会议系统 API

9、V1.0iPad 会议系统 API V1.0 第 9 页,共 18 页 回首页必选 类型及 范围 说明uid 1 int64 用户 iduser_email 0 string 用户邮箱user_age 0 string 用户年龄. 0 string .返回结果示例 “result” : 1,“uid” : “001”,“count” : 4,“user_info” : “姓名” : “小王 ”,“手机号” : “13111111111”,“邮箱” : “”,“年龄” : “18”.字段说明 iPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 10 页,共 18 页 回

10、首页返回值字段 字段类型 字段说明result int 1:成功 0:失败uid int64 当前用户的 idcount int 用户信息数量(包含用户未填项)user_info object 用户信息(包含用户未填项,未填返回空 string)2.11/ppt/items 读取本次会议所有要演示的 PPTURL http:/url/1/ppt/items.php支持格式 JSONHTTP 请求方式 iPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 11 页,共 18 页 回首页GET请求参数 必选 类型及 范围 说明返回结果示例 “result” : 1,“cou

11、nt” : 2,“ppt_items” : “ppt_id” : 001,“ppt_title” : “演讲一”,“ppt_author” : “小李”,“ppt_pages” : 20,“ppt_id” : 002,“ppt_title” : “演讲二”,iPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 12 页,共 18 页 回首页“ppt_author” : “小刘”,“ppt_pages” : 17,.字段说明 返回值字段 字段类型 字段说明result int 1:成功 0:失败count int 本次会议演讲 PPT 的个数ppt_items array

12、 PPT 项 目内容ppt_id int PPT 的 idppt_title string PPT 的 题目ppt_author string 此 PPT 演讲者ppt_pages int 此 PPT 的总页数2.21/ppt/current_state 读取当前 PPT 的状态URL http:/url/1/ppt/current_state.php支持格式 iPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 13 页,共 18 页 回首页JSONHTTP 请求方式 GET请求参数 必选 类型及 范围 说明返回结果示例 “result” : 1,“ppt_id” :

13、 001,“ppt_pages” : 20,“ppt_pages_current” : 3,“ppt_syn” : 1,“ppt_full_screen” : 0字段说明 iPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 14 页,共 18 页 回首页返回值字段 字段类型 字段说明result int 1:成功 0:失败ppt_id int PPT 的 idppt_pages int 当前 PPT 的总页数ppt_pages_current int 当前 PPT 的页码ppt_syn int 当前 PPT 是否同步演讲(1:同步 0 :不同步)ppt_full_sc

14、reen int 当前 PPT 是否全屏显示(1:全屏 0 :不全屏)3.11/chat/update 发送一条公共信息URL http:/url/1/chat/update.phpiPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 15 页,共 18 页 回首页支持格式 JSONHTTP 请求方式 POST请求参数 必选 类型及 范围 说明uid 1 int64 用户 idchat_message 1 string 信息内容返回结果示例 “result” : 1,“uid” : 001,“mid” : 001,“chat_message” : “你好”iPad 会议

15、系统 API V1.0iPad 会议系统 API V1.0 第 16 页,共 18 页 回首页字段说明 返回值字段 字段类型 字段说明result int 1:成功 0:失败uid int64 当前用户唯一标识符mid int64 信息的唯一标识符chat_message string 发送的信息内容URL http:/url/1/chat/private_update.php支持格式 JSONHTTP 请求方式 POST请求参数 必选类型及范围说明uid 1 int64 用户 idfriend_id 1 int64 私聊对象 idchat_private_message 1 string 私

16、聊信息内容iPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 17 页,共 18 页 回首页返回结果示例 “result” : 1,“uid” : 001,“friend_id” : 002,“private_mid” : 001,“chat_private_message” : “你好”字段说明 返回值字段 字段类型 字段说明result int 1:成功 0:失败uid int64 当前用户唯一标识符friend_id int64 私聊对象 idprivate_mid int64 私聊信息的唯一标识符chat_private_message string 私聊信息内容iPad 会议系统 API V1.0iPad 会议系统 API V1.0 第 18 页,共 18 页 回首页3.31/chat/read 根据 mid 读取未读公共信息URL http:/url/1/chat/read.php支持格式 JSONHTTP 请求方式 GET请求参数 必选 类型及 范围 说明uid 1 int64 用户 idmid 1 int64 信息 id

展开阅读全文
相关资源
猜你喜欢
相关搜索
资源标签

当前位置:首页 > 企业管理 > 管理学资料

本站链接:文库   一言   我酷   合作


客服QQ:2549714901微博号:道客多多官方知乎号:道客多多

经营许可证编号: 粤ICP备2021046453号世界地图

道客多多©版权所有2020-2025营业执照举报