接口文档实例要领.docxVIP

  • 5
  • 0
  • 约3.72千字
  • 约 19页
  • 2017-07-05 发布于湖北
  • 举报
注: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写入注册可选填写信息2 PPT接口读取接口ppt/items读取本次会议所有要演示的PPTppt/current_state读取当前PPT的状态3 聊天接口写入接口chat/update发送一条公共信息chat/private_update根据friend_id发送一条私聊信息读取接口chat/read根据mid读取未读公共信息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提交现场调查答案三、API详情1.11/user/register_optional_read读取系统注册可选信息项URL http://url/1/user/register_optional_read.php支持格式JSONHTTP请求方式GET请求参数必选类型及范围说明返回结果示例{“result”: 1,“count”: 2,“content”:[“邮箱”,“年龄”,...]}字段说明返回值字段字段类型字段说明resultint1:成功 0:失败countint注册可选项个数contentarray注册可选项内容1.21/user/read_info通过uid获取用户所有信息URL http://url/1/user/read_info.php支持格式JSONHTTP请求方式GET请求参数必选类型及范围说明uid1int64用户uid返回结果示例{“result”: 1,“uid”: “001”,“count”: 4,“user_info”: {“姓名”: “小王”,“手机号”: ,“邮箱”: “a@”,“年龄”: “”...}}字段说明返回值字段字段类型字段说明resultint1:成功 0:失败uidint64当前用户的idcountint用户信息数量(包含用户未填项)user_infoobject用户信息(包含用户未填项,未填返回空string)1.31/user/register_required_info写入注册必填信息URL http://url/1/user/register_required_info.php支持格式JSONHTTP请求方式GET请求参数必选类型及范围说明user_name1string用户姓名user_phone_number1string用户手机号码返回结果示例{“result”: 1,“uid”: 001,“user_name”: “小王”,“user_phone_number”: }字段说明返回值字段字段类型字段说明resultint1:成功 0:失败uidint64当前用户唯一标识符user_namestring用户姓名user_phone_numberstring用户手机号码1.41/user/register_optional_info写入注册可选填写信息URL http://url/1/user/register_optional_info.php支持格式JSONHTTP请求方式POST请求参数必选类型及范围说明uid1int64用户iduser_email0string用户邮箱user_age0string用户年龄...0string...返回结果示例{“result”: 1,“uid”: “001”,“count”: 4,“user_info”: {“姓名”: “小王”,“手机号”: ,“邮箱”: “a

文档评论(0)

1亿VIP精品文档

相关文档