获取当前登录用户的好友资料

接口说明

取出当前登录用户的好友资料

访问权限

请求Access Token时如果没有传递scope参数,则只能获取到好友的基本资料(返回字段说明中标明basic的字段,其中一些字段需要在接口调用时设置fields才能获取)。

如需获得好友的更多资料,需设置friends_类权限,详细权限名称请参考 返回字段说明权限列表

请求URL地址

OAuth1.0a access token方式:http://api.kaixin001.com/friends/me.(json|xml)
OAuth2.0 access token方式:https://api.kaixin001.com/friends/me.(json|xml)
session key方式:https://api.kaixin001.com/friends/me.(json|xml)

支持格式

XML/JSON

是否使用HTTPS连接

OAuth1.0a access token方式:否
OAuth2.0 access token方式:是
session key方式:是

HTTP请求方式

GET

是否需要登录

TRUE

注意事项

为了保护用户隐私,只有用户设置了公开或对好友设置了公开的数据才会返回。

如果请求数据不合法,或者超过请求频率限制,返回HTTP状态码400。

如果没有进行身份验证,返回HTTP状态码401。

如果没有权限访问对应的资源,返回HTTP状态码403。

如果请求的资源不存在,返回HTTP状态码404。

如果服务器内部错误,返回HTTP状态码500。

如果接口API关闭或正在升级,返回HTTP状态码502。

调用示例

http://api.kaixin001.com/friends/me.json?oauth_consumer_key=518888999058becc3e7c6676e2c914d7&oauth_nonce=20d1a3265b0c20e54095cceecc5d0c98&oauth_signature=SBTUUXZtpVF%2FMvUW2MBYcfTSoSg%3D&oauth_signature_method=HMAC-SHA1&oauth_timestamp=1309861543&oauth_token=46765_100003084_46765_1309338099_707bd340be5cd864f96c48f4b3d3700a&oauth_version=1.0

请求参数说明

api参数

fields:允许用户自定义返回字段,多个属性之间用英文半角逗号作为分隔符。
用户的所有属性:uid, name, gender, hometown, city, status, logo120, logo50, birthday, bodyform, blood, marriage, trainwith, interest, favbook, favmovie, favtv, idol, motto, wishlist, intro, education, schooltype, school, class, year, career, company, dept, beginyear, beginmonth, endyear, endmonth, isStar,pinyin,online
用户的基本属性:uid, name, gender, logo50
当fields字段为空的时候只返回用户的基本属性。

start:起始搜索 (选填,默认0)。

num:需要返回记录的个数(选填,默认20,最多50)。

gid:好友分组的id(选填,如果填写,则只返回该分组下的好友。 通过/friends/group接口可以获得gid列表)。

OAuth1.0验证参数

oauth_token:授权的access token。

oauth_consumer_key:应用的App Key。

oauth_signature_method:签名方法,暂只支持HMAC-SHA1。

oauth_signature:签名值,密钥为oauth_comsumer_secret和oauth_token_secret以&作为分隔符拼起来。

oauth_timestamp:时间戳, 其值是距1970 00:00:00 GMT的秒数。

oauth_nonce:单次值,随机生成的32位字符串,防止重放攻击(每次请求必须不同)。

oauth_version:(可选) 版本号,如果有必须为 1.0。

OAuth2.0验证参数

access_token:授权的access token。

调试工具地址

返回结果示例

XML示例:

<?xml version="1.0" encoding="UTF-8"?>
<userlist>
<users>
<user>
<uid>47002</uid>
<name> 刘二</name>
<gender>0</gender>
<hometown>北京</hometown>
<city>北京</city>
<status>2</status>
<logo120>http://pic.kaixin008.com.cn/logo/4/70/120_47002_1.jpg</logo120>
<logo50>http: //pic.kaixin008.com.cn/logo/4/70/50_47002_1.jpg</logo50>
<birthday>1780-10-10</birthday>
<blood>1</blood>
<marriage>1</marriage>
<trainwith>迈克尔 乔丹</trainwith>
<interest>打篮球</interest>
<favbook>武 侠 金庸大叔的书</favbook>
<favmovie>美国大片</favmovie>
<favtv> 美剧和动画片</favtv>
<idol>迈克尔 乔丹</idol>
<motto>爱拼才会赢</motto>
<wishlist>买个车子,卡丁车</wishlist>
<intro>啦啦啦啦啦啦啦</intro>
<education>
<college>
<schooltype>0</schooltype>
<school>北京大学</school>
<class>金融 11</class>
<year>2010</year>
</college>
</education>
<career>
<job>
<company>开心网</company>
<dept>技术</dept>
<beginyear>2010</beginyear>
<beginmonth>10</beginmonth>
<endyear></endyear>
<endmonth></endmonth>
</job>
</career>
<isStar>0</isStar>
</user>
</users>
</userlist>

JSON示例:

{
    "users": [{
        "uid": "47002",
        "name": "刘二",
        "gender": "0",
        "hometown": "北京",
        "city": "北京",
        "status": "2",
        "logo120": "http://pic.kaixin008.com.cn/logo/4/70/120_47002_1.jpg",
        "logo50": "http://pic.kaixin008.com.cn/logo/4/70/50_47002_1.jpg",
        "birthday": "1780-10-10",
        "blood": "1",
        "marriage": "1",
        "trainwith": "迈克尔 乔丹",
        "interest": "打篮球",
        "favbook": "武侠 金庸大叔的书",
        "favmovie": "美国大片",
        "favtv": "美剧和动画片",
        "idol": "迈克尔 乔丹",
        "motto": "爱拼才会赢",
        "wishlist": "买个车子,卡丁车",
        "intro": "啦啦啦啦啦啦啦",
        "education": [{
            "schooltype": "0",
            "school": "北京大学",
            "class": "金融 11",
            "year": "2010"
        }],
        "career": [{
            "company": "开心网",
            "dept": "技术",
            "beginyear": "2010",
            "beginmonth": "10",
            "endyear": "",
            "endmonth": ""
        }],
        "isStar": "0"
    }]
}

返回结果字段说明

字段说明好友资料权限类型
total好友总数basicstring
uid用户IDbasicstring
name用户名basicstring
gender性别
0:男
1:女
basicstring
hometown家乡basicstring
city现居住地basicstring
status状态
0:其它
1:学生
2:已工作
basicstring
logo120头像120 x 120basicstring
logo50头像50 x 50basicstring
birthday生日friends_birthdaystring
bodyform体型
0:保密
1:苗条
2:匀称
3:健壮
4:高大
5:小巧
6:丰满
7:高挑
8:较胖
9:较瘦
10:运动型
friends_bodyformstring
blood血型
0:没有填写
1:O型血
2:A型血
3:B型血
4:AB型血
5:稀有血型
friends_bloodstring
marriage婚姻状态
0:没有填写
1:单身
2:恋爱中
3:订婚
4:已婚
5:离异
friends_marriagestring
trainwith希望结交friends_introstring
interest兴趣爱好friends_introstring
favbook喜欢的书籍friends_introstring
favmovie喜欢的电影friends_introstring
favtv喜欢的电视剧friends_introstring
idol偶像friends_introstring
motto座右铭friends_introstring
wishlist愿望列表friends_introstring
intro介绍friends_introstring
education教育经历friends_educationarray
 schooltype学校类型friends_educationstring
 school学校friends_educationstring
 class班级friends_educationstring
 year入学年份friends_educationstring
career工作经历friends_careerarray
 company公司名称friends_careerstring
 dept所在部门friends_careerstring
 beginyear当前工作开始年份friends_careerstring
 beginmonth当前工作开始月份friends_careerstring
 endyear当前工作结束年份friends_careerstring
 endmonth当前工作结束月份friends_careerstring
isStar是否公共主页
0:否
1:是
basicstring
pinyin用户的姓名拼音basicstring
online用户是否在线
0:不在线
1:在线
friends_onlinestring

错误代码释义