接口文档实例.pdf

《接口文档实例.pdf》由会员分享，可在线阅读，更多相关《接口文档实例.pdf（19页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、 注：1、接口 URL 采用：域+API 版本号+资源类+接口名+参数。2、以返回结果例如为准，返回结果字段说明只对局部不清晰的字段作出说明。3、因为客户端是 ，数据载体用轻便的 JSON 格式。一、概览 用户接口 PPT 接口 聊天接口 名片接口 通知接口 二、说明 用户接口 读取接口 user/register_optional_read 读取系统注册可选信息项 user/read_info 通过 uid 获取用户所有信息 写入接口 user/register_required_info 写入注册必填信息 user/register_optional_info 写入注册可选填写信息 接口

2、读取接口 ppt/items 读取本次会议所有要演示的 PPT ppt/current_state 读取当前 PPT 的状态 聊天接口 写入接口 chat/update 发送一条公共信息 chat/private_update 根据 friend_id 发送一条私聊信息 读取接口 chat/read 根据 mid 读取未读公共信息 聊天接口 chat/private_read 根据 private_mid 获取未读私聊信息 名片接口 读取接口 card/user_list 获取所有用户列表 card/f_info 根据 uid 获取朋友信息 card/invit 获取当前用户未读被邀请信息 写

3、入接口 card/get_request 发送交换名片请求 card/confirm 确认是否分享名片给请求者 通知接口 读取接口 notification/meeting_info 获取本次会议信息 notification/survey_read 获取现场调查题目 notification/polling 轮询 写入接口 notification/suggest 反应建议 notification/survey_write 提交现场调查答案 三、详情 1/user/register_optional_read 读取系统注册可选信息项 URL :/url/1/user/register_op

4、tional_read.php 支持格式 JSON 请求方式 GET 请求参数 必选 类型及范围 说明 返回结果例如 “result:1,“count:2,“content:“邮箱,“年龄,.字段说明 返回值字段 字段类型 字段说明 result int 1:成功 0:失败 count int 注册可选项个数 content array 注册可选项内容 1/user/read_info 通过 uid 获取用户所有信息 URL :/url/1/user/read_info.php 支持格式 JSON 请求方式 GET 请求参数 必选 类型及范围 说明 uid 1 int64 用户 uid 返回结

5、果例如 “result:1,“uid:“001,“count:4,“user_info:“姓名:“小王,“号:“,“邮箱:“aa ,“年龄:“.字段说明 返回值字段 字段类型 字段说明 result int 1:成功 0:失败 uid int64 当前用户的 id count int 用户信息数量包含用户未填项 返回值字段 字段类型 字段说明 user_info object 用户信息包含用户未填项，未填返回空string 1/user/register_required_info 写入注册必填信息 URL :/url/1/user/register_required_info.php 支持格

6、式 JSON 请求方式 GET 请求参数 必选 类型及范围 说明 user_name 1 string 用户姓名 user_phone_number 1 string 用户 号码 返回结果例如 “result:1,“uid:001,“user_name:“小王,“user_phone_number:“字段说明 返回值字段 字段类型 字段说明 result int 1:成功 0:失败 uid int64 当前用户唯一标识符 user_name string 用户姓名 返回值字段 字段类型 字段说明 user_phone_number string 用户 号码 1/user/register_op

7、tional_info 写入注册可选填写信息 URL :/url/1/user/register_optional_info.php 支持格式 JSON 请求方式 POST 请求参数 必选 类型及范围 说明 uid 1 int64 用户 id user_email 0 string 用户邮箱 user_age 0 string 用户年龄.0 string.返回结果例如 “result:1,“uid:“001,“count:4,“user_info:“姓名:“小王,“号:“,“邮箱:“aa ,“年龄:“18 .字段说明 返回值字段 字段类型 字段说明 result int 1:成功 0:失败 u

8、id int64 当前用户的 id count int 用户信息数量包含用户未填项 user_info object 用户信息包含用户未填项，未填返回空 string 1/ppt/items 读取本次会议所有要演示的 PPT URL :/url/1/ppt/items.php 支持格式 JSON 请求方式 GET 请求参数 必选 类型及范围 说明 返回结果例如 “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 ,.字段说明 返回值字段 字段类型 字段说明 result int 1:成功 0:失败 count int 本次会议演讲 PPT的个数 ppt_items array PPT工程内容 ppt_id int PPT的 id ppt_title string PPT的题目 ppt_author string 此 PPT演讲者 ppt_pages int 此 PPT的总页数 1/ppt/current_state 读取当前 PPT 的状态 URL :/url/1/ppt/current_state.php 支持格式 JSON 请求方式 GET

10、 请求参数 必选 类型及范围 说明 返回结果例如 “result:1,“ppt_id:001,“ppt_pages:20,“ppt_pages_current:3,“ppt_syn:1,“ppt_full_screen:0 字段说明 返回值字段 字段类型 字段说明 result int 1:成功 0:失败 ppt_id int PPT的 id ppt_pages int 当前 PPT的总页数 ppt_pages_current int 当前 PPT的页码 ppt_syn int 当前 PPT是否同步演讲1：同步 0：不同步 ppt_full_screen int 当前 PPT是否全屏显示1：全

11、屏 0：不全屏 1/chat/update 发送一条公共信息 URL :/url/1/chat/update.php 支持格式 JSON 请求方式 POST 请求参数 必选 类型及范围 说明 uid 1 int64 用户 id chat_message 1 string 信息内容 返回结果例如 “result:1,“uid:001,“mid:001,“chat_message:“你好 字段说明 返回值字段 字段类型 字段说明 result int 1:成功 0:失败 uid int64 当前用户唯一标识符 mid int64 信息的唯一标识符 chat_message string 发送的信息

12、内容 URL :/url/1/chat/private_update.php 支持格式 JSON 请求方式 POST 请求参数 必选 类型及范围 说明 uid 1 int64 用户 id friend_id 1 int64 私聊对象 id chat_private_message 1 string 私聊信息内容 返回结果例如 “result:1,“uid:001,“friend_id:002,“private_mid:001,“chat_private_message:“你好 字段说明 返回值字段 字段类型 字段说明 result int 1:成功 0:失败 uid int64 当前用户唯一标识符 返回值字段 字段类型 字段说明 friend_id int64 私聊对象 id private_mid int64 私聊信息的唯一标识符 chat_private_message string 私聊信息内容 1/chat/read 根据 mid 读取未读公共信息 URL :/url/1/chat/read.php 支持格式 JSON 请求方式 GET 请求参数 必选 类型及范围 说明 uid 1 int64 用户 id mid 1 int64 信息 id