飞信-文档-开发者-API文档

于 2013-08-27 16:58:26 发布
阅读量1k 收藏
点赞数
分类专栏： 飞信 文章标签： 飞信
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ytfy12/article/details/10404321
版权

来源：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_keystring申请应用时分配的api_key，调用接口时候代表应用的唯一身份
methodstringfriends.areFriends
call_idint当前调用请求队列号，建议使用当前系统时间的毫秒值
sigstring它是由当前请求参数和secretKey的一个MD5值
vstringAPI的版本号，请设置成2
session_keystring登录用户的session key，用于验证是否为当前用户发出的请求
uids1string第一组用户的ID，每个ID之间以逗号分隔
uids2string第二组用户的ID，每个ID之间以逗号分隔
可选formatstringResponse的格式，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_keystring申请应用时分配的api_key，调用接口时候代表应用的唯一身份
methodstringfriends.get
call_idint当前调用请求队列号，建议使用当前系统时间的毫秒值
sigstring它是由当前请求参数和secretKey的一个MD5值
vstringAPI的版本号，请设置成2
session_keystring登录用户的session key，用于验证是否为当前用户发出的请求
可选formatstringResponse的格式，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_keystring申请应用时分配的api_key，调用接口时候代表应用的唯一身份
methodstringfriends.getfriend
call_idint当前调用请求队列号，建议使用当前系统时间的毫秒值
sigstring它是由当前请求参数和secretKey的一个MD5值
vstringAPI的版本号，请设置成2
session_keystring登录用户的session key，用于验证是否为当前用户发出的请求
可选formatstringResponse的格式，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_keystring申请应用时分配的api_key，调用接口时候代表应用的唯一身份
methodstringfriends.getAppUsers
call_idint当前调用请求队列号，建议使用当前系统时间的毫秒值
sigstring它是由当前请求参数和secretKey的一个MD5值
vstringAPI的版本号，请设置成2
session_keystring登录用户的session key，用于验证是否为当前用户发出的请求
可选formatstringResponse的格式，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

跳转到： 导航, 搜索

目录

[隐藏]

描述

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

参数列表

选择名称类型描述
必选api_keystring申请应用时分配的api_key，调用接口时候代表应用的唯一身份
methodstringfriends.getAppFriends
call_idint当前调用请求队列号，建议使用当前系统时间的毫秒值
sigstring它是由当前请求参数和secretKey的一个MD5值
vstringAPI的版本号，请设置成2
session_keystring登录用户的session key，用于验证是否为当前用户发出的请求
可选formatstringResponse的格式，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_keystring申请应用时分配的api_key，调用接口时候代表应用的唯一身份
methodstringusers.getInfo
call_idint当前调用请求队列号，建议使用当前系统时间的毫秒值
sigstring它是由当前请求参数和secretKey的一个MD5值
vstringAPI的版本号，请设置成2
session_keystring登录用户的session key，用于验证是否为当前用户发出的请求
uidsstring需要查询的用户id列表，用“,”隔开
可选formatstringResponse的格式，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_keystring申请应用时分配的api_key，调用接口时候代表应用的唯一身份
methodstringusers.getLoggedInUser
call_idint当前调用请求队列号，建议使用当前系统时间的毫秒值
sigstring它是由当前请求参数和secretKey的一个MD5值
vstringAPI的版本号，请设置成2
session_keystring登录用户的session key，用于验证是否为当前用户发出的请求
可选formatstringResponse的格式，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_keystring申请应用时分配的api_key，调用接口时候代表应用的唯一身份
methodstringusers.getLoggedInUser
call_idint当前调用请求队列号，建议使用当前系统时间的毫秒值
sigstring它是由当前请求参数和secretKey的一个MD5值
vstringAPI的版本号，请设置成2
可选formatstringResponse的格式，XML或者JSON，缺省值为XML
uidint用户id
session_keystring登录用户的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_keystring申请应用时分配的api_key，调用接口时候代表应用的唯一身份
methodstringusers.getLoggedInUser
call_idint当前调用请求队列号，建议使用当前系统时间的毫秒值
sigstring它是由当前请求参数和secretKey的一个MD5值
vstringAPI的版本号，请设置成2
session_keystring登录用户的session key，用于验证是否为当前用户发出的请求
可选formatstringResponse的格式，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 直接返回当前登录用户的手机号

 

逸天飞云
关注
专栏目录
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值