接口文档（完整）.doc

用户接口
checklogin 登录判断并返回当前用户的用户信息
HTTP请求方式：GET
请求参数：

说明
action
checklogin
email
用户登录的邮箱
password
用户登录的密码
返回结果：
字段
类型
说明
uid
int
用户uid
real_name
string
真实姓名
real_name_state
int
真实姓名的显示状态
0：所有人可见
1：我关注的人可见
2：仅自己可见
screen_name
string
昵称
remark
string
备注信息
gender
string
性别
province
string
省
city
string
市
birthday
string
出生日期
birthday_state
int
生日显示状态
0：公开，完整显示
1：只显示月日
2：保密
qq_number
string
qq号码
qq_number_state
int
qq号码显示状态
0：所有人可见
1：我关注的人可见
2：仅自己可见
school_name
string
学校名称
class_name
string
班级
tag
string
个人标签
impression
string
粉丝印象
profile_image_url
string
头像地址
followers_count
int
粉丝数
friedns_count
int
关注数
statuses_count
int
心情数
flowers_count
int
鲜花数
favourites_count
int
收藏数
blacklist_count
int
黑名单数
示例:
{
"uid":12345,
"real_name":"张三丰",
"real_name_state":0,
"screen_name":"大脑袋",
"remark":"张三疯",
"gender":"男",
"province":"北京市",
"city":"海淀区",
"birthday":"1987-01-01",
"birthday_state":0,
"qq_number":"123456",
"qq_number_state":0,
"school_name":"和谐小学",
"class_name":"10级3班",
"tag":"小孩子 80后 爱吃 听音乐",
"impression":"有大脑没智商 同上 同上",
"profile_image_url":"
"followers_count":18,
"friedns_count":20,
"statuses_count":35,
"flowers_count":18,
"favourites_count":24,
"blacklist_count":2
}
usershow 通过uid获取用户信息
HTTP请求方式：GET
请求参数：

说明
action
usershow
uid
要查询的用户uid
返回结果：同checklogin
示例：同checklogin
friends 获取用户关注列表，返回结果按关注时间倒序排列，最新关注的用户排在最前面。
HTTP请求方式：GET
请求参数：

说明
action
friends
uid
被查询用户的uid
page
关注分页的页码
count
每页显示的关注数
返回结果：
字段
类型
说明
uid
int
用户uid
screen_name
string
昵称
gender
string
性别
province
string
省
city
string
市
remark
string
备注
friends_state
int
当前登录用户是否已关注此用户
0：未关注
1：已关注
示例：
[
{
"uid":12345,
"screen_name":"大脑袋",
"remark":"张三疯",
"gender":"男",
"province":"北京市",
"city":"海淀区",
"friends_state":1
},
{
"uid":34556,
"screen_name":"小脑袋",
"remark":"假鲍鱼",
"gender":"男",
"province":"北京市",
"city":"海淀区",
"friends_state":1
},
......
]
follows 获取用户粉丝列表，返回结果按粉丝关注时间倒序排列，最新关注的粉丝排在最前面。
HTTP请求方式：GET
请求参数：

说明
action
follows
uid
被查询用户的uid
page
粉丝分页的页码
count
每页显示的粉丝数
返回结果：
字段
类型
说明
uid
int
用户uid
screen_name
string
昵称
gender
string
性别
province
string
省
city
string
市
remark
string
备注
friends_state
int
当前登录用户是否已关注此用户
0：未关注
1：已关注
示例：
[
{
"uid":12345,
"screen_name":"大脑袋",
"remark":"张三疯",
"gender":"男",
"province":"北京市",
"city":"海淀区",
"friends_state":1
},
{
"uid":34556,
"screen_name":"小脑袋",
"remark":"假鲍鱼",
"gender":"男",
"province":"北京市",
"city":"海淀区",
"friends_state":1
},
......
]
获取下行数据集(timeline)接口
friends_timeline 获取当前登录用户及其所关注用户的最新心情消息。跟登陆网站首页看到的效果相同。
HTTP请求方式：GET
请求参数：

说明
action
friendstimeline
page
心情分页的页码
count
每页显示的心情数
返回结果：
字段
类型
说明
mid
int
心情id
text
string
心情内容
created_at
string
创建时间
thumbnail_pic
string
缩略图url
original_pic
string
原始图片url
comment_count
int
评论数
share_count
int
分享数
favorited
string
是否已收藏
true：已收藏
false：未收藏
tag
string
标签：标签之间用空格隔开
user

发布人信息
uid
int
发布人uid
profile_image_url
string
发布人头像url
screen_name
string
发布人昵称
remark
string
备注
retweeted_mood

分享的心情信息，内容同心情。

示例：
[
{
"mid":12345,
"text":"今天天气不错啊。适合在家里。",
"created_at":"2011-07-14 11:12:13",
"thumbnail_pic":"
"original_pic":"
"comment_count":8,
"share_count":2,
"favorited":"true",
"tag":"不错 天气",
"user":
{
"uid":123456,
"profile_image_url":"
"screen_name":"大脑袋"
"remark":"张三疯"
},
"retweeted_mood":
{
"mid":1256756,
"text":"下雨了。",
"created_at":"2011-07-14 10:11:12",
"thumbnail_pic":"",
"original_pic":"",
"comment_count":7,
"share_count":1,
"user":
{
"uid":1234534,
"screen_name":"小脑袋"
}
}
},
......
]
user_timeline 获取用户的最新心情消息列表
HTTP请求方式：GET
请求参数：

说明
action
usertimeline
uid
查询用户的uid
page
心情分页的页码
count
每页显示的心情数
返回结果：
字段
类型
说明
mid
int
心情id
text
string
心情内容
created_at
string
创建时间
thumbnail_pic
string
缩略图url
original_pic
string
原始图片url
comment_count
int
评论数
share_count
int
分享数
favorited
string
是否已收藏
true：已收藏
false：未收藏
tag
string
标签：标签之间用空格隔开
user

发布人信息
uid
int
发布人uid
profile_image_url
string
发布人头像url
screen_name
string
发布人昵称
remark
string
备注
retweeted_mood

分享的心情信息，内容同心情。
示例：同friends_timeline
comments 根据心情消息id获得某条心情消息的评论列表
HTTP请求方式：GET
请求参数：

说明
action
comments
mid
心情的id
page
评论分页的页码
count
每页显示的评论数
返回结果：
字段
类型
说明
cid
int
评论id
text
string
评论内容
created_at
string
创建时间
user

发布人信息
uid
int
发布人uid
screen_name
string
发布人昵称
remark
string
备注

示例：
[
{
"cid":12354,
"text":"艳阳高照啊。",
"created_at":"2011-07-14 11:12:13",
"user":
{
"uid":123456,
"screen_name":"大脑袋"
"remark":"张三疯"
}
},
......
]
心情访问接口
update 发表一条心情消息以及分享一条心情消息
HTTP请求方式：POST
请求参数：

说明
action
update
text
心情正文
reply_mid
转发的心情id
pic
上传的图片
返回结果：
字段
类型
说明
is_success
int
表明是否发表成功
0：成功
1：失败
示例：
{
"is_success":0
}
delete 删除一条心情消息
HTTP请求方式：GET
请求参数：

说明
action
delete
mid
心情id
返回结果：
字段
类型
说明
is_success
int
表明是否删除成功
0：成功
1：失败
示例：
{
"is_success":0
}
comment 评论一条心情消息
HTTP请求方式：POST
请求参数：

说明
action
comment
mid
心情id
text
评论
uid
被评论人的id
返回结果：
字段
类型
说明
is_success
int
表明是否评论成功
0：成功
1：失败
示例：
{
"is_success":0
}
comment_delete 删除一条评论，只可以删除自己的
HTTP请求方式：GET
请求参数：

说明
action
commentdelete
cid
评论id
uid
当前登陆用户的id
返回结果：
字段
类型
说明
is_success
int
表明评论是否删除成功
0：成功
1：失败
示例：
{
"is_success":0
}
关注接口
friendships_create 关注一个用户
HTTP请求方式：GET
请求参数：

说明
action
friendshipscreate
uid
被关注人的uid
返回结果：
字段
类型
说明
is_success
int
表明是否关注成功
0：成功
1：失败
示例：
{
"is_success":0
}
friendships_destroy 取消对一个用户的关注
HTTP请求方式：GET
请求参数：

说明
action
friendshipsdestroy
uid
被关注人的uid
返回结果：
字段
类型
说明
is_success
int
表明取消是否成功
0：成功
1：失败
示例：
{
"is_success":0
}
friendships_exists 返回当前用户是否已关注被查询人
HTTP请求方式：GET
请求参数：

说明
action
friendshipsshow
uid
被查询人的uid
返回结果：
字段
类型
说明
is_success
int
表明是否已关注
0：成功
1：失败
示例：
{
"is_success":0
}
账号接口
logout 当前用户退出登录
HTTP请求方式：GET
请求参数：

说明
action
logout
uid
当前用户id
返回结果：
字段
类型
说明
is_success
int
表明是否退出登录成功
0：成功
1：失败
示例：
{
"is_success":0
}
update_profile_image 更改头像
HTTP请求方式：POST
请求参数：

说明
action
updateprofileimage
uid
当前用户id
pic
上传的图片
返回结果：
字段
类型
说明
is_success
int
头像是否更新成功
0：成功
1：失败
new_ profile_image_url
sting
头像的新地址
示例：
{
"is_success":0,
"new_ profile_image_url":"
}
update_profile 更改资料
HTTP请求方式：POST
请求参数：

说明
action
updateprofile
uid
当前用户id
data
用户资料
返回结果：
字段
类型
说明
is_success
int
头像是否更新成功
0：成功
1：失败
示例：
{
"is_success":0
}
收藏接口
favorites 获取当前用户的收藏列表
HTTP请求方式：GET
请求参数：

说明
action
favorites
page
收藏分页的页码
count
每页显示的收藏数
返回结果：
字段
类型
说明
id
int
心情id
text
string
心情内容
created_at
string
创建时间
thumbnail_pic
string
缩略图url
original_pic
string
原始图片url
comment_count
int
评论数
share_count
int
分享数
favorited
string
是否已收藏
true：已收藏
false：未收藏
tag
string
标签：标签之间用空格隔开
user

发布人信息
uid
int
发布人uid
profile_image_url
string
发布人头像url
screen_name
string
发布人昵称
remark
string
备注
retweeted_mood

分享的心情信息，内容同心情。
示例：同friends_timeline
favorites_create 添加收藏
HTTP请求方式：GET
请求参数：

说明
action
favoritescreate
mid
心情id
返回结果：
字段
类型
说明
is_success
int
收藏是否添加成功
0：成功
1：失败
示例：
{
"is_success":0
}
favorites_destroy 删除当前用户收藏的微博信息
HTTP请求方式：GET
请求参数：

说明
action
favoritesdestroy
mid
心情id
返回结果：
字段
类型
说明
is_success
int
收藏是否删除成功
0：成功
1：失败
示例：
{
"is_success":0
}
黑名单接口
blacklist_create 将某用户加入黑名单
HTTP请求方式：GET
请求参数：

说明
action
blacklistcreate
uid
被加入黑名单的用户的id
返回结果：
字段
类型
说明
is_success
int
加黑是否成功
0：成功
1：失败

示例：
{
"is_success":0
}
blacklist_destroy 将某用户移出黑名单
HTTP请求方式：GET
请求参数：

说明
action
blacklistdestroy
uid
被移出黑名单的用户的id
返回结果：
字段
类型
说明
is_success
int
移出黑名单是否成功
0：成功
1：失败
示例：
{
"is_success":0
}
blacklist 列出黑名单用户
HTTP请求方式：GET
请求参数：

说明
action
blacklist
page
黑名单分页的页码
count
每页显示的黑名单数
返回结果：
字段
类型
说明
user

黑名单用户
uid
int
用户id
profile_image_url
string
用户头像url
screen_name
string
用户昵称
remark
string
备注
{
"user":
{
"uid":123123,
"profile_image_url":"
"screen_name":"大脑袋",
"remark":"张三疯",
},
......
}
通知接口
notice_list 列出通知
HTTP请求方式：GET
请求参数：

说明
action
noticelist
page
通知分页的页码
count
每页显示的通知数
返回结果：
字段
类型
说明
notice

通知
nid
int
通知id
user

发布通知的用户
uid
int
发布通知的用户id
profile_image_url
string
发布通知的用户头像url
screen_name
string
发布通知的用户昵称
remark
string
备注
title
string
通知标题
text
string
通知内容
created_at
string
创建时间
示例：
[
{
"nid":123123,
"user":
{
"uid":"12344",
"profile_image_url":"
"screen_name":"大脑袋",
"remark":"张三疯",
},
"title":"系统通知",
"text":"今天所有人免费发送平板电脑一台。",
"created_at":"2011-07-14 11:12:13"
},
......
]
notice_delete 删除某条通知
HTTP请求方式：GET
请求参数：

说明
action
noticedelete
nid
通知的id
返回结果：
字段
类型
说明
is_success
int
通知是否删除成功
0：成功
1：失败
示例：
{
"is_success":0
}
notice_delete_all 删除所有通知
HTTP请求方式：GET
请求参数：

说明
action
noticedeleteall
返回结果：
字段
类型
说明
is_success
int
所有通知是否删除成功
0：成功
1：失败
示例：
{
"is_success":0
}
短信接口
shortmessage_list 列出短信
HTTP请求方式：GET
请求参数：

说明
action
shortmessagelist
page
短信的分页页码
count
每个分页显示的短信数
返回结果：
字段
类型
说明
shortmessage

短信
sid
int
短信id
dialogue_count
int
每条短信中对话的条数
user

与当前登录用户进行短信的用户
（简称：短信用户）
uid
int
短信用户id
profile_image_url
string
短信用户url
screen_name
string
短信用户昵称
remark
string
短信用户备注
dialogue

短信中的一条对话
did
int
对话id
test
string
对话内容
create_at
string
对话创建时间
示例：
[
{
"sid":123123,
"dialogue_count":10,
"user":
{
"uid":"12344",
"profile_image_url":"
"screen_name":"大脑袋",
"remark":"张三疯"
},
"dialogue":
{
"did":123123,
"test":"吃饭了吗",
"create_at":"2011-07-14 11:12:13"
}
},
......
]
shortmessage_show 列出与某用户短信的详细条目
HTTP请求方式：GET
请求参数：

说明
action
shortmessageshow
sid
短信id
page
短信中对话的分页页码
count
每个分页显示的对话数
返回结果：
字段
类型
说明
dialogue

短信中的一条对话
did
int
对话id
test
string
对话内容
create_at
string
对话创建时间
示例：
[
{
"did":3423,
"test":"我吃饭了",
"create_at":"2011-07-14 11:12:13"
},
.....
]
shortmessage_create 创建一条短信
HTTP请求方式：POST
请求参数：

说明

action
shortmessagecreate

uid
接受短信用户的id

text
短信正文

返回结果：
字段
类型
说明
is_success
int
短信是否发送成功
0：成功
1：失败
示例：
{
"is_success":0
}
shortmessage_delete 删除某条短消息中的一条对话
HTTP请求方式：GET
请求参数：

说明
action
shortmessagedelete
did
对话id
返回结果：
字段
类型
说明
is_success
int
对话是否删除成功
0：成功
1：失败
示例：
{
"is_success":0
}
shortmessage_delete_all 删除与某用户的所有短消息
HTTP请求方式：GET
请求参数：

说明
action
shortmessagedeleteall
sid
短信id
返回结果：
字段
类型
说明
is_success
int
短信是否删除成功
0：成功
1：失败
示例：
{
"is_success":0
}