来源：http://i3.feixin.10086.cn/wiki/API%E6%96%87%E6%A1%A3

API文档

出自MyWiki

跳转到： 导航, 搜索

接口概述

　　飞信开放平台API是采用REST基础的接口规范。所有的飞信开放平台API都是通过HTTP POST向飞信REST服务器

(http://i.feixin.10086.cn/api/service) 发送请求来实现的。几乎所有的计算机语言都可以通过HTTP协议同REST服务器通信。

　　特别注意:在向飞信REST服务器发送POST请求时，必须对value进行URL编码（UTF-8）才能正确调用，尤其是

session_key，如果不编码，服务器无法正确读取，可能会返回session_key无效的错误提示。

　　注：http://i.feixin.10086.cn/api/service 为现网地址，接口联调时必须

接口列表

　friends.areFriends（判断好友关系）

Friends.areFriends

出自MyWiki

跳转到： 导航, 搜索

描述

判断两组用户是否互为好友关系，比较的两组用户数必须相等

参数列表

选择 名称 类型 描述
必选 api_key string 申请应用时分配的api_key，调用接口时候代表应用的唯一身份
method string friends.areFriends
call_id int 当前调用请求队列号，建议使用当前系统时间的毫秒值
sig string 它是由当前请求参数和secretKey的一个MD5值
v string API的版本号，请设置成2
session_key string 登录用户的session key，用于验证是否为当前用户发出的请求
uids1 string 第一组用户的ID，每个ID之间以逗号分隔
uids2 string 第二组用户的ID，每个ID之间以逗号分隔
可选 format string Response的格式，XML或者JSON，缺省值为XML

返回结果示例

XML

<?xml version="1.0" encoding="UTF-8"?>
<friends_areFriends_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns=" http://app.api.fetion.com.cn/v1.0/">
<friend_info>
<uid1>100246</uid1>
<uid2>100245</uid2>
<are_friends>true</are_friends>
</friend_info>
<friend_info>
<uid1>100244</uid1>
<uid2>100243</uid2>
<are_friends>false</are_friends>
</friend_info>
</friends_areFriends_response>

JSON

[{“uid1”:100246,”uid2”:100245,”are_friends”:true},
{“uid1”:100244,”uid2”:100243,”are_friends”:false}]

返回结果说明

　　uid1 相对比的第一组中的用户id

　　uid2 相对比的第二组中的用户id

　　are_friends 是否为好友，true表示是，false表示否

　friends.get（获得好友uid列表）

Friends.get

出自MyWiki

跳转到： 导航, 搜索

描述

　　得到当前登录用户的好友列表，得到的只是含有好友uid的列表。

参数列表

选择 名称 类型 描述
必选 api_key string 申请应用时分配的api_key，调用接口时候代表应用的唯一身份
method string friends.get
call_id int 当前调用请求队列号，建议使用当前系统时间的毫秒值
sig string 它是由当前请求参数和secretKey的一个MD5值
v string API的版本号，请设置成2
session_key string 登录用户的session key，用于验证是否为当前用户发出的请求
可选 format string Response的格式，XML或者JSON，缺省值为XML

返回结果示例

XML

<?xml version="1.0" encoding="UTF-8"?>
<friends_get_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns=" http://app.api.fetion.com.cn/v1.0/"">
<uid>200032219</uid>
<uid>84525914</uid>
</friends_get_response>

JSON

　[ 27740660, 200009399 ]

返回结果说明

　uid 好友的用户id

取自“ http://i.feixin.10086.cn/wiki/Friends.get”

　friends.getfriends（获得好友摘要信息列表）

Friends.getfriends

出自MyWiki

跳转到： 导航, 搜索

描述

　　得到当前登录用户的好友列表，得到是含有好友摘要信息的列表。

参数列表

选择 名称 类型 描述
必选 api_key string 申请应用时分配的api_key，调用接口时候代表应用的唯一身份
method string friends.getfriend
call_id int 当前调用请求队列号，建议使用当前系统时间的毫秒值
sig string 它是由当前请求参数和secretKey的一个MD5值
v string API的版本号，请设置成2
session_key string 登录用户的session key，用于验证是否为当前用户发出的请求
可选 format string Response的格式，XML或者JSON，缺省值为XML

返回结果示例

XML

<?xml version="1.0" encoding="utf-8" ?>
<friends_getFriends_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://app.api.fetion.com.cn/v1.0/">
<group>
<id>2</id>
<name>test</name>
<friends>
<friend>
<id>103322</id>
<nickname>chi3</nickname>
<tinyurl>48x48.jpg</tinyurl>
<headurl>96x96.jpg</headurl>
<mainurl>180x180.jpg</mainurl>
</friend>
</friends>
</group>
<group>
<id>1</id>
<name>我的好友</name>
<friends>
<friend>
<id>100463</id>
<nickname>昵称</nickname>
<tinyurl>48x48.jpg</tinyurl>
<headurl>96x96.jpg</headurl>
<mainurl>180x180.jpg</mainurl>
</friend>
<friend>
<id>100250</id>
<nickname>70用户</nickname>
<tinyurl>48x48.jpg</tinyurl>
<headurl>96x96.jpg</headurl>
<mainurl>180x180.jpg</mainurl>
</friend>
</friends>
</group>
</friends_getFriends_response>

JSON

[{"id":2,"name":"test","friends":[{"id":103322,"nickname":"chi3","tinyurl":"48x48.jpg",
"headurl":"96x96.jpg","mainurl":"180x180.jpg"}]},
{"id":1,"name":"我的好友","friends":[{"id":100463,"nickname":"","tinyurl":"48x48.jpg",
"headurl":"96x96.jpg","mainurl":"180x180.jpg"},
{"id":100250,"nickname":"70用户","tinyurl":"48x48.jpg",
"headurl":"96x96.jpg","mainurl":"180x180.jpg"}]}}]

返回结果说明

　　friend 节点表示一个好友的信息

　　group 节点表示好友分组

　　id 子节点表示好友的用户ID

　　name 子节点表示好友的名字

　　headurl 子节点表示好友的头像（96*96）

　　tinyurl子节点表示好友的小头像（48*48）

　　mainurl子节点表示好友的大头像（180*180）

　friends.getAppUsers（获得添加应用的好友的用户id列表）

Friends.getAppUsers

出自MyWiki

跳转到： 导航, 搜索

描述

　　返回已经添加了一个应用的好友的用户Id列表，此接口只返回用户id。

参数列表

选择 名称 类型 描述
必选 api_key string 申请应用时分配的api_key，调用接口时候代表应用的唯一身份
method string friends.getAppUsers
call_id int 当前调用请求队列号，建议使用当前系统时间的毫秒值
sig string 它是由当前请求参数和secretKey的一个MD5值
v string API的版本号，请设置成2
session_key string 登录用户的session key，用于验证是否为当前用户发出的请求
可选 format string Response的格式，XML或者JSON，缺省值为XML

返回结果示例

XML

<?xml version="1.0" encoding="UTF-8"?>
<friends_getAppUsers_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns=" http://app.api.fetion.com.cn/v1.0/"">
<uid>200032219</uid>
<uid>84525914</uid>
</friends_getAppUsers_response>

JSON

[ 27740660, 200009399 ]

返回结果说明

　　uid 好友的用户id

取自“ http://i.feixin.10086.cn/wiki/Friends.getAppUsers”

　friends.getAppFriends（获得添加应用的好友的用户摘要信息列表）

Friends.getAppFriends

出自MyWiki

跳转到： 导航, 搜索

目录

[隐藏]

  • 1 描述
  • 2 参数列表
  • 3 返回结果示例
  • 4 返回结果说明

描述

　　返回已经添加了一个应用的好友的用户摘要信息列表

参数列表

选择 名称 类型 描述
必选 api_key string 申请应用时分配的api_key，调用接口时候代表应用的唯一身份
method string friends.getAppFriends
call_id int 当前调用请求队列号，建议使用当前系统时间的毫秒值
sig string 它是由当前请求参数和secretKey的一个MD5值
v string API的版本号，请设置成2
session_key string 登录用户的session key，用于验证是否为当前用户发出的请求
可选 format string Response的格式，XML或者JSON，缺省值为XML

返回结果示例

XML

<?xml version="1.0" encoding="utf-8" ?>
<friends_getFriends_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://app.api.fetion.com.cn/v1.0/">
<group>
<id>2</id>
<name>test</name>
<friends>
<friend>
<id>103322</id>
<nickname>chi3</nickname>
<tinyurl>48x48.jpg</tinyurl>
<headurl>96x96.jpg</headurl>
<mainurl>180x180.jpg</mainurl>
</friend>
</friends>
</group>
<group>
<id>1</id>
<name>我的好友</name>
<friends>
<friend>
<id>100463</id>
<nickname>昵称</nickname>
<tinyurl>48x48.jpg</tinyurl>
<headurl>96x96.jpg</headurl>
<mainurl>180x180.jpg</mainurl>
</friend>
<friend>
<id>100250</id>
<nickname>70用户</nickname>
<tinyurl>48x48.jpg</tinyurl>
<headurl>96x96.jpg</headurl>
<mainurl>180x180.jpg</mainurl>
</friend>
</friends>
</group>
</friends_getFriends_response>

JSON

[{"id":2,"name":"test","friends":[{"id":103322,"nickname":"chi3","tinyurl":"48x48.jpg",
"headurl":"96x96.jpg","mainurl":"180x180.jpg"}]},
{"id":1,"name":"我的好友","friends":[{"id":100463,"nickname":"","tinyurl":"48x48.jpg",
"headurl":"96x96.jpg","mainurl":"180x180.jpg"},
{"id":100250,"nickname":"7用户","tinyurl":"48x48.jpg",
"headurl":"96x96.jpg","mainurl":"180x180.jpg"}]}}]

返回结果说明

　　friend 节点表示一个好友的信息

　　group 节点表示好友分组

　　id 子节点表示好友的用户ID

　　name 子节点表示好友的名字

　　headurl 子节点表示好友的头像（96*96）

　　tinyurl子节点表示好友的小头像（48*48）

　　mainurl子节点表示好友的大头像（180*180）

　users.getInfo（获得指定用户信息）

Users.getInfo

出自MyWiki

跳转到： 导航, 搜索

描述

　　得到指定用户的信息

参数列表

选择 名称 类型 描述
必选 api_key string 申请应用时分配的api_key，调用接口时候代表应用的唯一身份
method string users.getInfo
call_id int 当前调用请求队列号，建议使用当前系统时间的毫秒值
sig string 它是由当前请求参数和secretKey的一个MD5值
v string API的版本号，请设置成2
session_key string 登录用户的session key，用于验证是否为当前用户发出的请求
uids string 需要查询的用户id列表，用“,”隔开
可选 format string Response的格式，XML或者JSON，缺省值为XML

返回结果示例

XML

<?xml version="1.0" encoding="UTF-8"?>
<users_getInfo_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns=" http://app.api.fetion.com.cn/v1.0/">
<user>
<uid>8055</uid>
<nickname>刘德华</name>
<gender>1</gender>
<birthday>1961-09-27</birthday>
<tinyurl>http://head.xiaonei.com/photos/tiny_10942g177.jpg</tinyurl>
<headurl>http://head.xiaonei.com/photos/tiny_10942g177.jpg</headurl></mainurl>
<hometown>
<province>黑龙江</province>
<city>哈尔滨</city>
</hometown>
</user>
</users_getInfo_response>

返回结果说明

　　uid 表示用户id

　　nickname 表示用户飞信昵称

　　web_nickname 表示用户网站昵称

　　gender表示性别，值1表示男性；值0表示女性

　　birthday 表示出生时间，格式为：yyyy-mm-dd，需要自行格式化日期显示格式

　　blood_type 表示用户血型

　　tinyurl 表示头像链接 48*48大小

　　headurl 表示头像链接 96*96大小

　　mainurl 表示头像链接 180*180大小

　　hometown 表示家乡信息

　　province（子节点） 表示所在省份

　　city（子节点） 表示所在城市

　　space_title空间名称

　　space_description空间描述

　　friend_type 交友目的

　　nature 性格

　　favorite_books 喜欢的书

　　favorite_movies 喜欢的电影

　　favorite_colors 喜欢的颜色

　　favorite_numbers 喜欢的数字

　　favorite_games 喜欢的游戏

　　favorite_musics 喜欢的音乐

　　most_hate 最讨厌的事

　　most_love 最喜欢的事

　　wish 心愿

　　introduction 个人简介

　　schools 就读过的学校

　　school（子节点） 表示一个学习

　　type（子节点）表示学校类型（1表示研究生、2表示本科、3大学专科、4中学）

　　name（子节点）表示学校名称

　　companies 就职过的公司（已移除）

　users.getLoggedInUser（获得当前session的用户ID）

Users.getLoggedInUser

出自MyWiki

跳转到： 导航, 搜索

描述

　　得到当前session的用户ID，返回的ID值应该在session有效期内被存储，从而避免重复地调用该方法。

参数列表

选择 名称 类型 描述
必选 api_key string 申请应用时分配的api_key，调用接口时候代表应用的唯一身份
method string users.getLoggedInUser
call_id int 当前调用请求队列号，建议使用当前系统时间的毫秒值
sig string 它是由当前请求参数和secretKey的一个MD5值
v string API的版本号，请设置成2
session_key string 登录用户的session key，用于验证是否为当前用户发出的请求
可选 format string Response的格式，XML或者JSON，缺省值为XML

返回结果示例

XML

<?xml version="1.0" encoding="UTF-8"?>
<users_getLoggedInUser_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns=" http://app.api.fetion.com.cn/v1.0/">
3333
</users_getLoggedInUser_response>

JSON

{ "uid":222332 }

返回结果说明

　　uid 直接返回当前登录用户的id

　users.isAppUser（判断用户应用授权）

Users.isAppUser

出自MyWiki

跳转到： 导航, 搜索

描述

　　判断用户是否已经对应用授权。这个接口里session_key不是必须的参数。

参数列表

选择 名称 类型 描述
必选 api_key string 申请应用时分配的api_key，调用接口时候代表应用的唯一身份
method string users.getLoggedInUser
call_id int 当前调用请求队列号，建议使用当前系统时间的毫秒值
sig string 它是由当前请求参数和secretKey的一个MD5值
v string API的版本号，请设置成2
可选 format string Response的格式，XML或者JSON，缺省值为XML
uid int 用户id
session_key string 登录用户的session key，用于验证是否为当前用户发出的请求

注意：在该接口中，对于参数session_key和uid，可任选其一，如果都有，将优先判断session_key对应的用户是否已对该应用授权。

返回结果示例

XML

<?xml version="1.0" encoding="UTF-8"?>
<users_isAppUser_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance"　
xmlns=" http://app.api.fetion.com.cn/v1.0/">
1
</users_isAppUser_response>

JSON

{ “result”:1 }

返回结果说明

　　result 如果返回结果是1，表示用户已经授权；如果返回0，表示用户还未授权。

取自“ http://i.feixin.10086.cn/wiki/Users.isAppUser”

　users.getLoggedInUserMobile（得到登录用户的手机号）

Users.getLoggedInUserMobile

出自MyWiki

跳转到： 导航, 搜索

描述

得到登录用户的手机号(此接口不对外)

参数列表

选择 名称 类型 描述
必选 api_key string 申请应用时分配的api_key，调用接口时候代表应用的唯一身份
method string users.getLoggedInUser
call_id int 当前调用请求队列号，建议使用当前系统时间的毫秒值
sig string 它是由当前请求参数和secretKey的一个MD5值
v string API的版本号，请设置成2
session_key string 登录用户的session key，用于验证是否为当前用户发出的请求
可选 format string Response的格式，XML或者JSON，缺省值为XML

返回结果示例

XML

<?xml version="1.0" encoding="UTF-8"?>
<users_getLoggedInUserMobile_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://app.api.fetion.com.cn/v1.0/">15010053449</users_getLoggedInUserMobile_response>

JSON

{"users_getLoggedInUserMobile_response":15010053449}

返回结果说明

　users_getLoggedInUserMobile_response 直接返回当前登录用户的手机号

飞信-文档-开发者-API文档相关推荐

  1. python3 chm文档下载_python3.7.0官方参考文档 最新api文档 chm_Python教程_源雷技术空间...

    资源名称:python3.7.0官方参考文档 最新api文档 chm 1.新语法特性: PEP 563, 推迟评估类型注释 2.向后不兼容语法更改: async 和 await 现在保留关键字 3.新 ...

  2. 使用Android Studio的时候如何查看开发文档，API文档，doc文档，SDK文档

    有的时候,我们在Android开发中需要查看需要的一些类或包里面有什么方法,返回值,调用关系和继承关系等等.这个时候我们就可以使用SDK软件开发工具中的其中之一--API文档,来查一下. 那么,下面就 ...

  3. python chm模块_python3.7.0官方参考文档 最新api文档 chm

    python 3.7.0 帮助文档,Python 3.7.0 documentation python3.7.0原版官方文档 英文版,CHM格式.修正显示乱码.基于官方在线文档修正编译. 简单方便的c ...

  4. 干掉 Postman？测试接口直接生成API文档，这个文档工具真香！

    欢迎关注方志朋的博客,回复"666"获面试宝典 实不相瞒我的收藏夹里躺着很多优质的开源项目,我有个爱好平时遇到感兴趣的开源项目都会记录下来,然后有时间在慢慢研究.前几天刚给同事分享 ...

  5. 干掉Postman？测试接口直接生成API文档，这工具强烈推荐！

    最近被身边几个做开发的朋友安利了一款国产的 API 开发调试神器,真的有被惊艳到!!!简直不要太好用! 没想到,中国也有了比 Postman 还好用的软件! 这个 API 开发调试神器就是 ApiPo ...

  6. 干掉 Postman？测试接口直接生成 API 文档，这工具真香！

    作者:小 G 来源:GitHubDaily " 阅读本文大概需要 5 分钟. " 前阵子,偶然发现一款国产 API 接口开发调试神器,上手尝鲜之后,真的有被惊艳到,功能齐全,对中文 ...

  7. java api文档_细说API – 文档和前后端协作

    在上一篇文章--<细说API – 重新认识RESTful>中介绍了如何理解和设计RESTful风格的API,现在我们来聊聊如何有效的呈现API文档,以及前后端协作的方式. 我经历过一些没有 ...

  8. swagger api文档_带有Swagger的Spring Rest API –公开文档

    swagger api文档 创建API文档后,将其提供给涉众很重要. 在理想情况下,此发布的文档将足够灵活以解决任何最后的更改,并且易于分发(就成本以及完成此操作所需的时间而言). 为了使之成为可能, ...

  9. API文档工具knife4j使用详解

    api文档 编写api文档是一个费时的操作,过程枯燥.那有没有一种可以自动生成api文档的工具呢,答案是有,比如swagger就是可以自动生成的,像yapi.apidoc.showdoc等等是需要我们 ...

最新文章

  1. 数字图像处理笔记二 - 图片缩放(最近邻插值(Nearest Neighbor interpolation))
  2. 关于工程教育和工程教育专业认证工作的思考——吴岩司长在工程教育高峰论坛上的讲话
  3. 芯片巨人也要搞医疗？
  4. python3 request模块 https certificate verify failed 错误
  5. 写入缓存策略无法更改_【第1747期】webpack 5 之持久化缓存指南
  6. 阿里云服务器邮件发送
  7. 02 - 替换SetInput方法 VTK 6.0 迁移 (2013-06-30 16:22)
  8. 阿特斯携手EDF启动建设巴西191.5MW光伏项目
  9. vs调用css写的c语言程序,c语言文件读写实例
  10. Eclipse JaveEE版本
  11. 湖州南浔张静江：“满堂花醉三千客，一剑霜寒四十州”
  12. 程序员学习交流的网站论坛
  13. 主板检测卡c5_电脑主板检测卡的代码是什么意思_电脑主板故障诊断检测卡代码汇总(5)_飞翔教程...
  14. Android Launcher负一屏实现方案
  15. k8s 存活检查与就绪检查
  16. 【SRS】ATC模式和时间抖动矫正
  17. 【01：转自知乎：关于 openSUSE 】
  18. 如何建立英文字符的哈希表
  19. 报：类com.qin.servlet.HelloServlet不是Servlet
  20. Azure Kinect 使用记录 (二)

热门文章

  1. simulink中mpc模块怎么使用_simulink中mpc模块
  2. VMware虚拟机黑屏解决办法
  3. 进程和线程：进程的状态和层次结构
  4. 真实DOM操作和虚拟DOM操作的比较
  5. 三、基于SpringBoot实现SSMP整合
  6. 使用SpringBoot2.0搭建企业级应用开发框架（一）基础框架生成
  7. 【转】Mockito教程
  8. Ubantu20.04查看显卡信息
  9. 大数据之hive实践二(DDL+DML+查询+函数)
  10. 一招解决hao123页面篡改Chrome谷歌浏览器