接口Xweibo微博API接口说明

Xweibo微博API接口说明Xweibo

201 1年6月

目 录

目录

1 接口概述.......................................................................................................................0

2 API调用说明...............................................................................................................0

2.1 参数说明. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .0

2.2 Api访问方式说明. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .0

3 API返回值说明...........................................................................................................1

3.1 返回格式 json. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

3.2 返回结构 {"rst":返回结果,"errno":结果代码,"err":"错误提示信息"} . . . . . . . . . . 14 错误代码.......................................................................................................................1

4.1 参数检查错误代码. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

4.2 平台级别错误代码. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2

5 接口介绍.......................................................................................................................2

5.1 微博访问接口. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2

5.1 .1 action.update发布一条微博消息. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2

5.1 .2 action.destroy删除一条微博信息. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

5.1 .3 action.repost转发一条微博信息. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

5.1 .4 action.comment对一条微博信息进行评论. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

5.1 .5 action.comment.destroy删除微博评论. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

5.1 .6 action.reply 回复微博评论消息. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

5.2 关注接口. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

5.2.1 action.createFriendship关注某用户. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

5.2.2 action.deleteFriendship取消关注或移除粉丝. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

5.2.3 action.friendship查看某人是否为指定用户的粉丝. . . . . . . . . . . . . . . . . . . . . . .10

5.3 收藏接口. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

5.3.1 action.createFavorite添加收藏. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

5.3.2 action.deleteFavorite删除收藏. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

5.4 账号接口. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

5.4.1 action.updateProfi leImage更改头像. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

/)wwwWwQwmMmMMm℃2

Xweibo v21

5.4.2 action.saveProfi le更改个人资料. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

5.5 获取下行数据集Timel ine接口. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

5.5.1 action.unread获取当前用户未读消息数. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

5.5.2 action.getComments获取指定微博的评论列表. . . . . . . . . . . . . . . . . . . . . . . . . . .13

5.5.3 action.getCounts批量获取评论数和转发数. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 15

5.5.4 action.clearTip未读消息数清零接口. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 15

5.6 私信接口. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

5.6.1 action.sendDirectMessage发送私信. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

5.6.2 action.deleteDirectMessage删除私信. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

5.7 用户接口. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

5.7.1 action.createBlocks加入黑名单. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

5.7.2 action.deleteBlocks删除黑名单. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

5.7.3 action.createTags添加标签. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

5.7.4 action.deleteTags删除标签. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

5.8 其它接口. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

5.8.1 action.setting tip个人设置. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

5.8.2 action.sinaurl 解析短链接. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

5.8.4 action.saveNotice更新提醒设置和tip显示方式. . . . . . . . . . . . . . . . . . . . . . . . . .21

Xweibo微博API接口说明

1 接口概述

Xwe i b o不仅提供了快速、低成本架设微博的解决方案还提供了让第三方调用的API接口。第三方通过调用这些AP I接口可以轻松地为Xweibo推送内容 同时也能够从Xwe i b o获取所需的内容在自有网站上进行展示。

Xwei bo微博AP I接口是一座连接第三方网站与Xwei bo的桥梁。通过它站长可以实现自有站点与Xwe i b o无缝连接进行无障碍的内容共享。

2 API调用说明

2.1参数说明

在请求api的同时 post多以下三个参数ap i_s ign签名值md5(AP I_WB_AKEY.'#' .$ap i_uid.'#' .$ap i_time. '#' .API_WB_SKEY. '#' .$m.'#' .AP

I_KEY);

API_WB_AKEY默认使用申请微博应用的app key

API_WB_SKEY默认使用申请微博应用的app secret

$m是访问ap i的接口名。 比如要访问发微博ap i $m=‘up date’ 。

API_KEY约定加密的keyap i_uid第三方绑定的用户uidap i_t ime 当前请求的时间时间戳。

2.2 Api访问方式说明

某些api允许使用匿名身份或者系统默认帐号进行访问

如果需要使用匿名身份访问部分api

请设置变量 $allow_anonymous的值默认是空数组。 比如

$allow_anonymous = array( ‘getTokenAuthorizeURL’ ) ;

那么接口 getTokenAuthorizeURL就可以使用匿名身份访问

/)wwwWwQwmMmMMm℃0

Xweibo v21

如果需要使用默认帐号访问部分api

请设置变量 $allow_others的值默认是空数组。 比如

$allow_others = array( ‘update’ , ’ comment’ ) ;

那么接口 update和comment就可以使用系统帐号访问

使用这个两种方式访问api api_uid可以为空或一个不存在的uid值。3 API返回值说明

3.1返回格式 json

3.2返回结构 {错误提

示信息"}

1)返回结果 json格式的字符串或单独的字符

2)结果代码正确的返回是 0 错误的返回是一个错误代码

3)错误提示信息方便分析问题。 自定义的或接口本身的错误内容4 错误代码

错误以7位数字表示。比如 1010000前两位表示主类别第二三位表示子类别后三位用来表示错误代码。错误代码分为公共的错误代码和接口特定的错误代码。参数检查错误代码以及平台级别错误属于公共的错误代码如下所示

4.1参数检查错误代码

。

-1-

4.2平台级别错误代码

5 接口介绍

5.1微博访问接口

5.1 .1 action.update发布一条微博消息

4) URL http://server/?m=api/weibo/action.update

5)请求参数

微博/)wwwWwQwmMmMMm℃2

Xweibo v21

6)返回格式

7)接口错误代码

5.1 .2 action.destroy删除一条微博信息

8) URL http://serve r/?m=api/weibo/action.destroy

9)参数列表

10)返回格式

1 1)接口错误代码

5.1 .3 action.repost转发一条微博信息

12)URL http://serve r/?m=api/weibo/action.repost

13)参数列表

14)返回格式

/)wwwWwQwmMmMMm℃4

Xweibo v21

字。

5.1 .4 action.comment对一条微博信息进行评论

16)URL http://server/?m=api/weibo/action.comment

17)参数列表

18)返回格式