Methods summary
public
|
#
__construct( mixed $akey, mixed $skey, mixed $access_token, mixed $refresh_token = NULL )
构造函数
Parameters
- $akey
- 微博开放平台应用APP KEY
- $skey
- 微博开放平台应用APP SECRET
- $access_token
- OAuth认证返回的token
- $refresh_token
- OAuth认证返回的token secret
|
public
|
#
set_debug( boolean $enable )
开启调试信息
开启调试信息后,SDK会将每次请求微博API所发送的POST Data、Headers以及请求信息、返回内容输出出来。
Parameters
|
public
boolean
|
#
set_remote_ip( string $ip )
设置用户IP
SDK默认将会通过$_SERVER['REMOTE_ADDR']获取用户IP,在请求微博API时将用户IP附加到Request Header中。但某些情况下$_SERVER['REMOTE_ADDR']取到的IP并非用户IP,而是一个固定的IP(例如使用SAE的Cron或TaskQueue服务时),此时就有可能会造成该固定IP达到微博API调用频率限额,导致API调用失败。此时可使用本方法设置用户IP,以避免此问题。
Parameters
Returns
boolean IP为非法IP字符串时,返回false,否则返回true
|
public
array
|
#
public_timeline( integer $page = 1, integer $count = 50, integer $base_app = 0 )
获取最新的公共微博消息
对应API:statuses/public_timeline
Parameters
- $page
- $count 单页返回的记录条数,默认为50。
- $count
- $page 返回结果的页码,默认为1。
- $base_app
- 是否只获取当前应用的数据。0为否(所有数据),1为是(仅当前应用),默认为0。
Returns
array
|
public
array
|
#
home_timeline( integer $page = 1, integer $count = 50, integer $since_id = 0, integer $max_id = 0, integer $base_app = 0, integer $feature = 0 )
获取当前登录用户及其所关注用户的最新微博消息。
获取当前登录用户及其所关注用户的最新微博消息。和用户登录 http://weibo.com 后在“我的首页”中看到的内容相同。同friends_timeline()
对应API:statuses/home_timeline
Parameters
- $page
- 指定返回结果的页码。根据当前登录用户所关注的用户数及这些被关注用户发表的微博数,翻页功能最多能查看的总记录数会有所不同,通常最多能查看1000条左右。默认值1。可选。
- $count
- 每次返回的记录数。缺省值50,最大值200。可选。
- $since_id
- 若指定此参数,则只返回ID比since_id大的微博消息(即比since_id发表时间晚的微博消息)。可选。
- $max_id
- 若指定此参数,则返回ID小于或等于max_id的微博消息。可选。
- $base_app
- 是否只获取当前应用的数据。0为否(所有数据),1为是(仅当前应用),默认为0。
- $feature
- 过滤类型ID,0:全部、1:原创、2:图片、3:视频、4:音乐,默认为0。
Returns
array
|
public
array
|
#
friends_timeline( integer $page = 1, integer $count = 50, integer $since_id = 0, integer $max_id = 0, integer $base_app = 0, integer $feature = 0 )
获取当前登录用户及其所关注用户的最新微博消息。
获取当前登录用户及其所关注用户的最新微博消息。和用户登录 http://weibo.com 后在“我的首页”中看到的内容相同。同home_timeline()
对应API:statuses/friends_timeline
Parameters
- $page
- 指定返回结果的页码。根据当前登录用户所关注的用户数及这些被关注用户发表的微博数,翻页功能最多能查看的总记录数会有所不同,通常最多能查看1000条左右。默认值1。可选。
- $count
- 每次返回的记录数。缺省值50,最大值200。可选。
- $since_id
- 若指定此参数,则只返回ID比since_id大的微博消息(即比since_id发表时间晚的微博消息)。可选。
- $max_id
- 若指定此参数,则返回ID小于或等于max_id的微博消息。可选。
- $base_app
- 是否基于当前应用来获取数据。1为限制本应用微博,0为不做限制。默认为0。可选。
- $feature
- 微博类型,0全部,1原创,2图片,3视频,4音乐. 返回指定类型的微博信息内容。转为为0。可选。
Returns
array
|
public
array
|
#
user_timeline_by_id( integer $uid = NULL , integer $page = 1 , mixed $count = 50 , integer $since_id = 0, integer $max_id = 0, integer $feature = 0, integer $trim_user = 0, integer $base_app = 0 )
获取用户发布的微博信息列表
返回用户的发布的最近n条信息,和用户微博页面返回内容是一致的。此接口也可以请求其他用户的最新发表微博。
对应API:statuses/user_timeline
Parameters
- $uid
- $page 页码
- $page
- $count 每次返回的最大记录数,最多返回200条,默认50。
- $count
- $uid 指定用户UID或微博昵称
- $since_id
- 若指定此参数,则只返回ID比since_id大的微博消息(即比since_id发表时间晚的微博消息)。可选。
- $max_id
- 若指定此参数,则返回ID小于或等于max_id的提到当前登录用户微博消息。可选。
- $feature
- $base_app 是否基于当前应用来获取数据。1为限制本应用微博,0为不做限制。默认为0。
- $trim_user
- $feature 过滤类型ID,0:全部、1:原创、2:图片、3:视频、4:音乐,默认为0。
- $base_app
- $trim_user 返回值中user信息开关,0:返回完整的user信息、1:user字段仅返回uid,默认为0。
Returns
array
|
public
array
|
#
user_timeline_by_name( string $screen_name = NULL , integer $page = 1 , integer $count = 50 , integer $since_id = 0, integer $max_id = 0, integer $feature = 0, integer $trim_user = 0, integer $base_app = 0 )
获取用户发布的微博信息列表
返回用户的发布的最近n条信息,和用户微博页面返回内容是一致的。此接口也可以请求其他用户的最新发表微博。
对应API:statuses/user_timeline
Parameters
- $screen_name
- 微博昵称,主要是用来区分用户UID跟微博昵称,当二者一样而产生歧义的时候,建议使用该参数
- $page
- 页码
- $count
- 每次返回的最大记录数,最多返回200条,默认50。
- $since_id
- 若指定此参数,则只返回ID比since_id大的微博消息(即比since_id发表时间晚的微博消息)。可选。
- $max_id
- 若指定此参数,则返回ID小于或等于max_id的提到当前登录用户微博消息。可选。
- $feature
- 过滤类型ID,0:全部、1:原创、2:图片、3:视频、4:音乐,默认为0。
- $trim_user
- 返回值中user信息开关,0:返回完整的user信息、1:user字段仅返回uid,默认为0。
- $base_app
- 是否基于当前应用来获取数据。1为限制本应用微博,0为不做限制。默认为0。
Returns
array
|
public
array
|
#
timeline_batch_by_name( string $screen_name, integer $page = 1, integer $count = 50, integer $feature = 0, integer $base_app = 0 )
批量获取指定的一批用户的timeline
对应API:statuses/timeline_batch
Parameters
- $screen_name
- 需要查询的用户昵称,用半角逗号分隔,一次最多20个
- $page
- $count 单页返回的记录条数,默认为50。
- $count
- $page 返回结果的页码,默认为1。
- $feature
- $base_app 是否只获取当前应用的数据。0为否(所有数据),1为是(仅当前应用),默认为0。
- $base_app
- $feature 过滤类型ID,0:全部、1:原创、2:图片、3:视频、4:音乐,默认为0。
Returns
array
|
public
array
|
#
timeline_batch_by_id( string $uids, integer $page = 1, integer $count = 50, integer $feature = 0, integer $base_app = 0 )
批量获取指定的一批用户的timeline
对应API:statuses/timeline_batch
Parameters
- $uids
- 需要查询的用户ID,用半角逗号分隔,一次最多20个。
- $page
- $count 单页返回的记录条数,默认为50。
- $count
- $page 返回结果的页码,默认为1。
- $feature
- $base_app 是否只获取当前应用的数据。0为否(所有数据),1为是(仅当前应用),默认为0。
- $base_app
- $feature 过滤类型ID,0:全部、1:原创、2:图片、3:视频、4:音乐,默认为0。
Returns
array
|
public
array
|
#
repost_timeline( integer $sid, integer $page = 1, integer $count = 50, integer $since_id = 0, integer $max_id = 0, integer $filter_by_author = 0 )
返回一条原创微博消息的最新n条转发微博消息。本接口无法对非原创微博进行查询。
返回一条原创微博消息的最新n条转发微博消息。本接口无法对非原创微博进行查询。
对应API:statuses/repost_timeline
Parameters
- $sid
- 要获取转发微博列表的原创微博ID。
- $page
- 返回结果的页码。
- $count
- 单页返回的最大记录数,最多返回200条,默认50。可选。
- $since_id
- 若指定此参数,则只返回ID比since_id大的记录(比since_id发表时间晚)。可选。
- $max_id
- 若指定此参数,则返回ID小于或等于max_id的记录。可选。
- $filter_by_author
- 作者筛选类型,0:全部、1:我关注的人、2:陌生人,默认为0。
Returns
array
|
public
array
|
#
repost_by_me( integer $page = 1, integer $count = 50, integer $since_id = 0, integer $max_id = 0 )
获取当前用户最新转发的n条微博消息
对应API:statuses/repost_by_me
Parameters
- $page
- 返回结果的页码。
- $count
- 每次返回的最大记录数,最多返回200条,默认50。可选。
- $since_id
- 若指定此参数,则只返回ID比since_id大的记录(比since_id发表时间晚)。可选。
- $max_id
- 若指定此参数,则返回ID小于或等于max_id的记录。可选。
Returns
array
|
public
array
|
#
mentions( integer $page = 1, integer $count = 50, integer $since_id = 0, integer $max_id = 0, integer $filter_by_author = 0, integer $filter_by_source = 0, integer $filter_by_type = 0 )
获取@当前用户的微博列表
返回最新n条提到登录用户的微博消息(即包含@username的微博消息)
对应API:statuses/mentions
Parameters
- $page
- 返回结果的页序号。
- $count
- 每次返回的最大记录数(即页面大小),不大于200,默认为50。
- $since_id
- 若指定此参数,则只返回ID比since_id大的微博消息(即比since_id发表时间晚的微博消息)。可选。
- $max_id
- 若指定此参数,则返回ID小于或等于max_id的提到当前登录用户微博消息。可选。
- $filter_by_author
- 作者筛选类型,0:全部、1:我关注的人、2:陌生人,默认为0。
- $filter_by_source
- 来源筛选类型,0:全部、1:来自微博、2:来自微群,默认为0。
- $filter_by_type
- 原创筛选类型,0:全部微博、1:原创的微博,默认为0。
Returns
array
|
public
array
|
#
show_status( integer $id )
根据ID获取单条微博信息内容
获取单条ID的微博信息,作者信息将同时返回。
对应API:statuses/show
Parameters
- $id
- 要获取已发表的微博ID, 如ID不存在返回空
Returns
array
|
public
array
|
|
public
array
|
#
querymid( integer|string $id, integer $type = 1, integer $is_batch = 0 )
通过微博(评论、私信)ID获取其MID
对应API:statuses/querymid
Parameters
- $id
- 需要查询的微博(评论、私信)ID,批量模式下,用半角逗号分隔,最多不超过20个。
- $type
- 获取类型,1:微博、2:评论、3:私信,默认为1。
- $is_batch
- 是否使用批量模式,0:否、1:是,默认为0。
Returns
array
|
public
array
|
#
queryid( integer|string $mid, integer $type = 1, integer $is_batch = 0, integer $inbox = 0, integer $isBase62 = 0 )
通过微博(评论、私信)MID获取其ID
对应API:statuses/queryid
Parameters
- $mid
- 需要查询的微博(评论、私信)MID,批量模式下,用半角逗号分隔,最多不超过20个。
- $type
- 获取类型,1:微博、2:评论、3:私信,默认为1。
- $is_batch
- 是否使用批量模式,0:否、1:是,默认为0。
- $inbox
- 仅对私信有效,当MID类型为私信时用此参数,0:发件箱、1:收件箱,默认为0 。
- $isBase62
- MID是否是base62编码,0:否、1:是,默认为0。
Returns
array
|
public
array
|
#
repost_daily( integer $count = 20, integer $base_app = 0 )
按天返回热门微博转发榜的微博列表
对应API:statuses/hot/repost_daily
Parameters
- $count
- 返回的记录条数,最大不超过50,默认为20。
- $base_app
- 是否只获取当前应用的数据。0为否(所有数据),1为是(仅当前应用),默认为0。
Returns
array
|
public
array
|
#
repost_weekly( integer $count = 20, integer $base_app = 0 )
按周返回热门微博转发榜的微博列表
对应API:statuses/hot/repost_weekly
Parameters
- $count
- 返回的记录条数,最大不超过50,默认为20。
- $base_app
- 是否只获取当前应用的数据。0为否(所有数据),1为是(仅当前应用),默认为0。
Returns
array
|
public
array
|
#
repost( integer $sid, string $text = NULL, integer $is_comment = 0 )
转发一条微博信息。
可加评论。为防止重复,发布的信息与最新信息一样话,将会被忽略。
对应API:statuses/repost
Parameters
- $sid
- 转发的微博ID
- $text
- 添加的评论信息。可选。
- $is_comment
- 是否在转发的同时发表评论,0:否、1:评论给当前微博、2:评论给原微博、3:都评论,默认为0。
Returns
array
|
public
array
|
|
public
array
|
|
public
array
|
#
update( string $status, float $lat = NULL, float $long = NULL, mixed $annotations = NULL, integer $visible = 0 )
发表微博
发布一条微博信息。
注意:lat和long参数需配合使用,用于标记发表微博消息时所在的地理位置,只有用户设置中geo_enabled=true时候地理位置信息才有效。
注意:为防止重复提交,当用户发布的微博消息与上次成功发布的微博消息内容一样时,将返回400错误,给出错误提示:“40025:Error: repeated weibo text!“。
对应API:statuses/update
Parameters
- $status
- 要更新的微博信息。信息内容不超过140个汉字, 为空返回400错误。
- $lat
- 纬度,发表当前微博所在的地理位置,有效范围 -90.0到+90.0, +表示北纬。可选。
- $long
- 经度。有效范围-180.0到+180.0, +表示东经。可选。
- $annotations
- 可选参数。元数据,主要是为了方便第三方应用记录一些适合于自己使用的信息。每条微博可以包含一个或者多个元数据。请以json字串的形式提交,字串长度不超过512个字符,或者数组方式,要求json_encode后字串长度不超过512个字符。具体内容可以自定。例如:'[{"type2":123}, {"a":"b", "c":"d"}]'或array(array("type2"=>123), array("a"=>"b", "c"=>"d"))。
- $visible
- 微博的可见性,0:所有人能看,1:仅自己可见,2:密友可见,3:指定分组可见,默认为0
Returns
array
|
public
array
|
#
upload( string $status, string $pic_path, float $lat = NULL, float $long = NULL, integer $visible = 0 )
发表图片微博
发表图片微博消息。目前上传图片大小限制为<5M。
注意:lat和long参数需配合使用,用于标记发表微博消息时所在的地理位置,只有用户设置中geo_enabled=true时候地理位置信息才有效。
对应API:statuses/upload
Parameters
- $status
- 要更新的微博信息。信息内容不超过140个汉字, 为空返回400错误。
- $pic_path
- 要发布的图片路径, 支持url。[只支持png/jpg/gif三种格式, 增加格式请修改get_image_mime方法]
- $lat
- 纬度,发表当前微博所在的地理位置,有效范围 -90.0到+90.0, +表示北纬。可选。
- $long
- 可选参数,经度。有效范围-180.0到+180.0, +表示东经。可选。
- $visible
- 微博的可见性,0:所有人能看,1:仅自己可见,2:密友可见,3:指定分组可见,默认为0
Returns
array
|
public
array
|
#
share( string $status, string $pic = false, string $rip = false )
第三方分享一条链接到微博
目前上传图片大小限制为<5M。
对应API:http://open.weibo.com/wiki/2/statuses/share
Parameters
- $status
- 用户分享到微博的文本内容,必须做URLencode,内容不超过140个汉字,文本中不能包含“#话题词#”,同时文本中必须包含至少一个第三方分享到微博的网页URL,且该URL只能是该第三方(调用方)绑定域下的URL链接,绑定域在“我的应用 - 应用信息 - 基本应用信息编辑 - 安全域名”里设置,必填。
- $pic
- 用户想要分享到微博的图片,仅支持JPEG、GIF、PNG图片,上传图片大小限制为<5M。上传图片时,POST方式提交请求,需要采用multipart/form-data编码方式,可选。
- $rip
- 开发者上报的操作用户真实IP,形如:211.156.0.1,可选。
Returns
array
|
public
array
|
#
upload_url_text( string $status, integer $url, string $visible = 0, string $list_id = NULL, float $pic_id = NULL, float $lat = NULL, string $long = NULL, string $annotations = NULL )
指定一个图片URL地址抓取后上传并同时发布一条新微博
指定一个图片URL地址抓取后上传并同时发布一条新微博
对应API:statuses/upload_url_text
Parameters
- $status
- 要发布的微博文本内容,内容不超过140个汉字。
- $url
- $visible 微博的可见性,0:所有人能看,1:仅自己可见,2:密友可见,3:指定分组可见,默认为0
- $visible
- $list_id 微博的保护投递指定分组ID,只有当visible参数为3时生效且必选。
- $list_id
- $pic_id 已经上传的图片pid,多个时使用英文半角逗号符分隔,最多不超过9个。
- $pic_id
- $lat 纬度,有效范围:-90.0到+90.0,+表示北纬,默认为0.0。
- $lat
- $long 经度,有效范围:-180.0到+180.0,+表示东经,默认为0.0。
- $long
$annotations 元数据,主要是为了方便第三方应用记录一些适合于自己使用的信息,每条微博可以包含一个或者多个元数据,
必须以json字串的形式提交,字串长度不超过512个字符,具体内容可以自定。
- $annotations
- $url 图片的URL地址,必须以http开头。
Returns
array
|
public
array
|
#
emotions( string $type = "face", string $language = "cnname" )
获取表情列表
返回新浪微博官方所有表情、魔法表情的相关信息。包括短语、表情类型、表情分类,是否热门等。
对应API:emotions
Parameters
- $type
- 表情类别。"face":普通表情,"ani":魔法表情,"cartoon":动漫表情。默认为"face"。可选。
- $language
- 语言类别,"cnname"简体,"twname"繁体。默认为"cnname"。可选
Returns
array
|
public
array
|
#
reply( integer $sid, string $text, integer $cid, integer $without_mention = 0, integer $comment_ori = 0 )
回复一条评论
为防止重复,发布的信息与最后一条评论/回复信息一样话,将会被忽略。
对应API:comments/reply
Parameters
- $sid
- 微博id
- $text
- 评论内容。
- $cid
- 评论id
- $without_mention
- 1:回复中不自动加入“回复@用户名”,0:回复中自动加入“回复@用户名”.默认为0.
- $comment_ori
- 当评论转发微博时,是否评论给原微博,0:否、1:是,默认为0。
Returns
array
|
public
array
|
|
public
array
|
|
public
array
|
#
domain_show( mixed $domain )
通过个性化域名获取用户资料以及用户最新的一条微博
对应API:users/domain_show
Parameters
- $domain
- 用户个性域名。例如:lazypeople,而不是http://weibo.com/lazypeople
Returns
array
|
public
array
|
|
public
array
|
|
public
array
|
#
friends_by_id( integer $uid, integer $cursor = 0, integer $count = 50 )
获取用户的关注列表
如果没有提供cursor参数,将只返回最前面的5000个关注id
对应API:friendships/friends
Parameters
- $uid
- $cursor 返回结果的游标,下一页用返回值里的next_cursor,上一页用previous_cursor,默认为0。
- $cursor
- $count 单页返回的记录条数,默认为50,最大不超过200。
- $count
- $uid 要获取的用户的ID。
Returns
array
|
public
array
|
#
friends_by_name( integer $screen_name, integer $cursor = 0, string $count = 50 )
获取用户的关注列表
如果没有提供cursor参数,将只返回最前面的5000个关注id
对应API:friendships/friends
Parameters
- $screen_name
- $cursor 返回结果的游标,下一页用返回值里的next_cursor,上一页用previous_cursor,默认为0。
- $cursor
- $count 单页返回的记录条数,默认为50,最大不超过200。
- $count
- $screen_name 要获取的用户的 screen_name
Returns
array
|
public
array
|
#
friends_in_common( integer $uid, integer $suid = NULL, integer $page = 1, integer $count = 50 )
获取两个用户之间的共同关注人列表
对应API:friendships/friends/in_common
Parameters
- $uid
- 需要获取共同关注关系的用户UID
- $suid
- 需要获取共同关注关系的用户UID,默认为当前登录用户。
- $page
- $count 单页返回的记录条数,默认为50。
- $count
- $page 返回结果的页码,默认为1。
Returns
array
|
public
array
|
#
bilateral( integer $uid, integer $page = 1, integer $count = 50, integer $sort = 0 )
获取用户的双向关注列表,即互粉列表
对应API:friendships/friends/bilateral
Parameters
- $uid
- 需要获取双向关注列表的用户UID。
- $page
- $count 单页返回的记录条数,默认为50。
- $count
- $page 返回结果的页码,默认为1。
- $sort
- 排序类型,0:按关注时间最近排序,默认为0。
Returns
array
|
public
array
|
#
bilateral_ids( integer $uid, integer $page = 1, integer $count = 50, integer $sort = 0 )
获取用户的双向关注uid列表
对应API:friendships/friends/bilateral/ids
Parameters
- $uid
- 需要获取双向关注列表的用户UID。
- $page
- $count 单页返回的记录条数,默认为50。
- $count
- $page 返回结果的页码,默认为1。
- $sort
- 排序类型,0:按关注时间最近排序,默认为0。
Returns
array
|
public
array
|
#
friends_ids_by_id( integer $uid, integer $cursor = 0, integer $count = 500 )
获取用户的关注列表uid
如果没有提供cursor参数,将只返回最前面的5000个关注id
对应API:friendships/friends/ids
Parameters
- $uid
- $cursor 返回结果的游标,下一页用返回值里的next_cursor,上一页用previous_cursor,默认为0。
- $cursor
- $count 每次返回的最大记录数(即页面大小),不大于5000, 默认返回500。
- $count
- $uid 要获取的用户 UID,默认为当前用户
Returns
array
|
public
array
|
#
friends_ids_by_name( integer $screen_name, integer $cursor = 0, string $count = 500 )
获取用户的关注列表uid
如果没有提供cursor参数,将只返回最前面的5000个关注id
对应API:friendships/friends/ids
Parameters
- $screen_name
- $cursor 返回结果的游标,下一页用返回值里的next_cursor,上一页用previous_cursor,默认为0。
- $cursor
- $count 每次返回的最大记录数(即页面大小),不大于5000, 默认返回500。
- $count
- $screen_name 要获取的用户的 screen_name,默认为当前用户
Returns
array
|
public
array
|
#
followers_by_id( integer $uid, integer $cursor = 0 , integer $count = 50 )
获取用户的粉丝列表
对应API:friendships/followers
Parameters
- $uid
- 需要查询的用户UID
- $cursor
- $count 单页返回的记录条数,默认为50,最大不超过200。
- $count
- $cursor false 返回结果的游标,下一页用返回值里的next_cursor,上一页用previous_cursor,默认为0。
Returns
array
|
public
array
|
#
followers_by_name( string $screen_name, integer $cursor = 0 , integer $count = 50 )
获取用户的粉丝列表
对应API:friendships/followers
Parameters
- $screen_name
- 需要查询的用户的昵称
- $cursor
- $count 单页返回的记录条数,默认为50,最大不超过200。
- $count
- $cursor false 返回结果的游标,下一页用返回值里的next_cursor,上一页用previous_cursor,默认为0。
Returns
array
|
public
array
|
#
followers_ids_by_id( integer $uid, integer $cursor = 0 , integer $count = 50 )
获取用户的粉丝列表uid
对应API:friendships/followers
Parameters
- $uid
- 需要查询的用户UID
- $cursor
- $count 单页返回的记录条数,默认为50,最大不超过200。
- $count
- $cursor 返回结果的游标,下一页用返回值里的next_cursor,上一页用previous_cursor,默认为0。
Returns
array
|
public
array
|
#
followers_ids_by_name( string $screen_name, integer $cursor = 0 , integer $count = 50 )
获取用户的粉丝列表uid
对应API:friendships/followers
Parameters
- $screen_name
- 需要查询的用户screen_name
- $cursor
- $count 单页返回的记录条数,默认为50,最大不超过200。
- $count
- $cursor 返回结果的游标,下一页用返回值里的next_cursor,上一页用previous_cursor,默认为0。
Returns
array
|
public
array
|
|
public
array
|
|
public
array
|
#
is_followed_by_id( mixed $target_id, mixed $source_id = NULL )
返回两个用户关系的详细情况
如果源用户或目的用户不存在,将返回http的400错误
对应API:friendships/show
Parameters
- $target_id
- 目标用户UID
- $source_id
- 源用户UID,可选,默认为当前的用户
Returns
array
|
public
array
|
#
is_followed_by_name( mixed $target_name, mixed $source_name = NULL )
返回两个用户关系的详细情况
如果源用户或目的用户不存在,将返回http的400错误
对应API:friendships/show
Parameters
- $target_name
- 目标用户的微博昵称
- $source_name
- 源用户的微博昵称,可选,默认为当前的用户
Returns
array
|
public
array
|
#
follow_by_id( integer $uid )
关注一个用户。
成功则返回关注人的资料,目前最多关注2000人,失败则返回一条字符串的说明。如果已经关注了此人,则返回http 403的状态。关注不存在的ID将返回400。
对应API:friendships/create
Parameters
Returns
array
|
public
array
|
#
follow_by_name( string $screen_name )
关注一个用户。
成功则返回关注人的资料,目前的最多关注2000人,失败则返回一条字符串的说明。如果已经关注了此人,则返回http 403的状态。关注不存在的ID将返回400。
对应API:friendships/create
Parameters
Returns
array
|
public
array
|
|
public
array
|
|
public
array
|
|
public
array
|
#
list_dm( integer $page = 1, integer $count = 50, int64 $since_id = 0, int64 $max_id = 0 )
获取当前用户最新私信列表
返回用户的最新n条私信,并包含发送者和接受者的详细资料。
对应API:direct_messages
Parameters
- $page
- 页码
- $count
- 每次返回的最大记录数,最多返回200条,默认50。
- $since_id
- 返回ID比数值since_id大(比since_id时间晚的)的私信。可选。
- $max_id
- 返回ID不大于max_id(时间不晚于max_id)的私信。可选。
Returns
array
|
public
array
|
#
list_dm_sent( integer $page = 1, integer $count = 50, int64 $since_id = 0, int64 $max_id = 0 )
获取当前用户发送的最新私信列表
返回登录用户已发送最新50条私信。包括发送者和接受者的详细资料。
对应API:direct_messages/sent
Parameters
- $page
- 页码
- $count
- 每次返回的最大记录数,最多返回200条,默认50。
- $since_id
- 返回ID比数值since_id大(比since_id时间晚的)的私信。可选。
- $max_id
- 返回ID不大于max_id(时间不晚于max_id)的私信。可选。
Returns
array
|
public
array
|
#
dm_user_list( integer $count = 20, integer $cursor = 0 )
获取与当前登录用户有私信往来的用户列表,与该用户往来的最新私信
获取与当前登录用户有私信往来的用户列表,与该用户往来的最新私信
对应API:direct_messages/user_list
Parameters
- $count
- 单页返回的记录条数,默认为20。
- $cursor
- 返回结果的游标,下一页用返回值里的next_cursor,上一页用previous_cursor,默认为0。
Returns
array
|
public
array
|
#
dm_conversation( integer $uid, integer $page = 1, integer $count = 50, integer $since_id = 0, integer $max_id = 0 )
获取与指定用户的往来私信列表
对应API:direct_messages/conversation
Parameters
- $uid
- 需要查询的用户的UID。
- $page
- $since_id 若指定此参数,则返回ID比since_id大的私信(即比since_id时间晚的私信),默认为0。
- $count
- $max_id 若指定此参数,则返回ID小于或等于max_id的私信,默认为0。
- $since_id
- $count 单页返回的记录条数,默认为50。
- $max_id
- $page 返回结果的页码,默认为1。
Returns
array
|
public
array
|
|
public
array
|
#
send_dm_by_id( integer $uid, string $text, integer $id = NULL )
发送私信
发送一条私信。成功将返回完整的发送消息。
对应API:direct_messages/new
Parameters
- $uid
- 用户UID
- $text
- 要发生的消息内容,文本大小必须小于300个汉字。
- $id
- 需要发送的微博ID。
Returns
array
|
public
array
|
#
send_dm_by_name( string $screen_name, string $text, integer $id = NULL )
发送私信
发送一条私信。成功将返回完整的发送消息。
对应API:direct_messages/new
Parameters
- $screen_name
- 用户昵称
- $text
- 要发生的消息内容,文本大小必须小于300个汉字。
- $id
- 需要发送的微博ID。
Returns
array
|
public
array
|
|
public
array
|
#
delete_dms( mixed $dids )
批量删除私信
批量删除当前登录用户的私信。出现异常时,返回400错误。
对应API:direct_messages/destroy_batch
Parameters
- $dids
- 欲删除的一组私信ID,用半角逗号隔开,或者由一组评论ID组成的数组。最多20个。例如:"4976494627, 4976262053"或array(4976494627,4976262053);
Returns
array
|
public
array
|
|
public
array
|
|
public
array
|
|
public
array
|
|
public
array
|
|
public
array
|
|
public
array
|
#
school_list( array $query )
获取所有的学校列表
对应API:account/profile/school_list
Parameters
- $query
搜索选项。格式:array('key0'=>'value0', 'key1'=>'value1', ....)。支持的key:
- province int 省份范围,省份ID。
- city int 城市范围,城市ID。
- area int 区域范围,区ID。
- type int 学校类型,1:大学、2:高中、3:中专技校、4:初中、5:小学,默认为1。
- capital string 学校首字母,默认为A。
- keyword string 学校名称关键字。
- count int 返回的记录条数,默认为10。
参数keyword与capital二者必选其一,且只能选其一。按首字母capital查询时,必须提供province参数。
Returns
array
|
public
array
|
|
public
array
|
|
public
array
|
#
update_profile( array $profile )
更改用户资料
对应API:account/profile/basic_update
Parameters
- $profile
要修改的资料。格式:array('key1'=>'value1', 'key2'=>'value2', .....)。
支持修改的项:
- screen_name string 用户昵称,不可为空。
- gender i string 用户性别,m:男、f:女,不可为空。
- real_name string 用户真实姓名。
- real_name_visible int 真实姓名可见范围,0:自己可见、1:关注人可见、2:所有人可见。
- province true int 省份代码ID,不可为空。
- city true int 城市代码ID,不可为空。
- birthday string 用户生日,格式:yyyy-mm-dd。
- birthday_visible int 生日可见范围,0:保密、1:只显示月日、2:只显示星座、3:所有人可见。
- qq string 用户QQ号码。
- qq_visible int 用户QQ可见范围,0:自己可见、1:关注人可见、2:所有人可见。
- msn string 用户MSN。
- msn_visible int 用户MSN可见范围,0:自己可见、1:关注人可见、2:所有人可见。
- url string 用户博客地址。
- url_visible int 用户博客地址可见范围,0:自己可见、1:关注人可见、2:所有人可见。
- credentials_type int 证件类型,1:身份证、2:学生证、3:军官证、4:护照。
- credentials_num string 证件号码。
- email string 用户常用邮箱地址。
- email_visible int 用户常用邮箱地址可见范围,0:自己可见、1:关注人可见、2:所有人可见。
- lang string 语言版本,zh_cn:简体中文、zh_tw:繁体中文。
- description string 用户描述,最长不超过70个汉字。
填写birthday参数时,做如下约定:
- 只填年份时,采用1986-00-00格式;
- 只填月份时,采用0000-08-00格式;
- 只填某日时,采用0000-00-28格式。
Returns
array
|
public
array
|
#
edu_update( array $edu_update )
设置教育信息
对应API:account/profile/edu_update
Parameters
- $edu_update
要修改的学校信息。格式:array('key1'=>'value1', 'key2'=>'value2', .....)。
支持设置的项:
- type int 学校类型,1:大学、2:高中、3:中专技校、4:初中、5:小学,默认为1。必填参数
- school_id ` int 学校代码,必填参数
- id string 需要修改的教育信息ID,不传则为新建,传则为更新。
- year int 入学年份,最小为1900,最大不超过当前年份
- department string 院系或者班别。
- visible int 开放等级,0:仅自己可见、1:关注的人可见、2:所有人可见。
Returns
array
|
public
array
|
|
public
array
|
#
car_update( array $car_update )
设置职业信息
对应API:account/profile/car_update
Parameters
- $car_update
要修改的职业信息。格式:array('key1'=>'value1', 'key2'=>'value2', .....)。
支持设置的项:
- id string 需要更新的职业信息ID。
- start int 进入公司年份,最小为1900,最大为当年年份。
- end int 离开公司年份,至今填0。
- department string 工作部门。
- visible int 可见范围,0:自己可见、1:关注人可见、2:所有人可见。
- province int 省份代码ID,不可为空值。
- city int 城市代码ID,不可为空值。
- company string 公司名称,不可为空值。
参数province与city二者必选其一
参数id为空,则为新建职业信息,参数company变为必填项,参数id非空,则为更新,参数company可选
Returns
array
|
public
array
|
|
public
array
|
#
update_profile_image( string $image_path )
更改头像
对应API:account/avatar/upload
Parameters
- $image_path
- 要上传的头像路径, 支持url。[只支持png/jpg/gif三种格式, 增加格式请修改get_image_mime方法] 必须为小于700K的有效的GIF, JPG图片. 如果图片大于500像素将按比例缩放。
Returns
array
|
public
array
|
#
update_privacy( array $privacy_settings )
设置隐私信息
对应API:account/update_privacy
Parameters
- $privacy_settings
要修改的隐私设置。格式:array('key1'=>'value1', 'key2'=>'value2', .....)。
支持设置的项:
- comment int 是否可以评论我的微博,0:所有人、1:关注的人,默认为0。
- geo int 是否开启地理信息,0:不开启、1:开启,默认为1。
- message int 是否可以给我发私信,0:所有人、1:关注的人,默认为0。
- realname int 是否可以通过真名搜索到我,0:不可以、1:可以,默认为0。
- badge int 勋章是否可见,0:不可见、1:可见,默认为1。
- mobile int 是否可以通过手机号码搜索到我,0:不可以、1:可以,默认为0。
以上参数全部选填
Returns
array
|
public
array
|
#
get_favorites( integer $page = 1, integer $count = 50 )
获取当前用户的收藏列表
返回用户的发布的最近20条收藏信息,和用户收藏页面返回内容是一致的。
对应API:favorites
Parameters
- $page
- 返回结果的页码,默认为1。
- $count
- 单页返回的记录条数,默认为50。
Returns
array
|
public
array
|
|
public
array
|
#
favorites_by_tags( integer $tid, integer $page = 1, integer $count = 50 )
根据标签获取当前登录用户该标签下的收藏列表
对应API:favorites/by_tags
Parameters
- $tid
- 需要查询的标签ID。'
- $page
- $count 单页返回的记录条数,默认为50。
- $count
- $page 返回结果的页码,默认为1。
Returns
array
|
public
array
|
#
favorites_tags( integer $page = 1, integer $count = 50 )
获取当前登录用户的收藏标签列表
对应API:favorites/tags
Parameters
- $page
- $count 单页返回的记录条数,默认为50。
- $count
- $page 返回结果的页码,默认为1。
Returns
array
|
public
array
|
|
public
array
|
|
public
array
|
#
remove_from_favorites_batch( mixed $fids )
批量删除微博收藏。
批量删除当前登录用户的收藏。出现异常时,返回HTTP400错误。
对应API:favorites/destroy_batch
Parameters
- $fids
- 欲删除的一组私信ID,用半角逗号隔开,或者由一组评论ID组成的数组。最多20个。例如:"231101027525486630,201100826122315375"或array(231101027525486630,201100826122315375);
Returns
array
|
public
array
|
|
public
array
|
|
public
array
|
|
public
array
|
#
get_trends( integer $uid = NULL, integer $page = 1, integer $count = 10 )
获取某用户的话题
对应API:trends
Parameters
- $uid
- 查询用户的ID。默认为当前用户。可选。
- $page
- 指定返回结果的页码。可选。
- $count
- 单页大小。缺省值10。可选。
Returns
array
|
public
array
|
|
public
array
|
#
hourly_trends( integer $base_app = 0 )
返回最近一小时内的热门话题
对应API:trends/hourly
Parameters
- $base_app
- 是否基于当前应用来获取数据。1表示基于当前应用来获取数据,默认为0。可选。
Returns
array
|
public
array
|
#
daily_trends( integer $base_app = 0 )
返回最近一天内的热门话题
对应API:trends/daily
Parameters
- $base_app
- 是否基于当前应用来获取数据。1表示基于当前应用来获取数据,默认为0。可选。
Returns
array
|
public
array
|
#
weekly_trends( integer $base_app = 0 )
返回最近一周内的热门话题
对应API:trends/weekly
Parameters
- $base_app
- 是否基于当前应用来获取数据。1表示基于当前应用来获取数据,默认为0。可选。
Returns
array
|
public
array
|
|
public
array
|
|
public
array
|
#
get_tags( integer $uid = NULL, integer $page = 1, integer $count = 20 )
返回指定用户的标签列表
对应API:tags
Parameters
- $uid
- 查询用户的ID。默认为当前用户。可选。
- $page
- 指定返回结果的页码。可选。
- $count
- 单页大小。缺省值20,最大值200。可选。
Returns
array
|
public
array
|
|
public
array
|
|
public
array
|
#
add_tags( mixed $tags )
为当前登录用户添加新的用户标签
对应API:tags/create
Parameters
- $tags
- 要创建的一组标签,每个标签的长度不可超过7个汉字,14个半角字符。多个标签之间用逗号间隔,或由多个标签构成的数组。如:"abc,drf,efgh,tt"或array("abc", "drf", "efgh", "tt")
Returns
array
|
public
array
|
|
public
array
|
#
delete_tags( mixed $ids )
批量删除标签
对应API:tags/destroy_batch
Parameters
- $ids
- 必选参数,要删除的tag id,多个id用半角逗号分割,最多10个。或由多个tag id构成的数组。如:“553,554,555"或array(553, 554, 555)
Returns
array
|
public
array
|
|
public
array
|
|
public
array
|
|
public
array
|
#
search_schools( string $q, integer $count = 10, integer $type = 1 )
搜索学校时的联想搜索建议
对应API:search/suggestions/schools
Parameters
- $q
- 搜索的关键字,必须做URLencoding。必填
- $count
- 返回的记录条数,默认为10。
- $type
- 学校类型,0:全部、1:大学、2:高中、3:中专技校、4:初中、5:小学,默认为0。选填
Returns
array
|
public
array
|
|
public
array
|
#
search_at_users( string $q, integer $count = 10, integer $type = 0, integer $range = 2 )
@用户时的联想建议
对应API:search/suggestions/at_users
Parameters
- $q
- 搜索的关键字,必须做URLencoding。必填
- $count
- 返回的记录条数,默认为10。
- $type
- 联想类型,0:关注、1:粉丝。必填
- $range
- 联想范围,0:只联想关注人、1:只联想关注人的备注、2:全部,默认为2。选填
Returns
array
|
public
array
|
#
search_statuses_high( array $query )
搜索与指定的一个或多个条件相匹配的微博
对应API:search/statuses
Parameters
- $query
搜索选项。格式:array('key0'=>'value0', 'key1'=>'value1', ....)。支持的key:
- q string 搜索的关键字,必须进行URLencode。
- filter_ori int 过滤器,是否为原创,0:全部、1:原创、2:转发,默认为0。
- filter_pic int 过滤器。是否包含图片,0:全部、1:包含、2:不包含,默认为0。
- fuid int 搜索的微博作者的用户UID。
- province int 搜索的省份范围,省份ID。
- city int 搜索的城市范围,城市ID。
- starttime int 开始时间,Unix时间戳。
- endtime int 结束时间,Unix时间戳。
- count int 单页返回的记录条数,默认为10。
- page int 返回结果的页码,默认为1。
- needcount boolean 返回结果中是否包含返回记录数,true:返回、false:不返回,默认为false。
- base_app int 是否只获取当前应用的数据。0为否(所有数据),1为是(仅当前应用),默认为0。
needcount参数不同,会导致相应的返回值结构不同
以上参数全部选填
Returns
array
|
public
array
|
#
search_users_keywords( array $query )
通过关键词搜索用户
对应API:search/users
Parameters
- $query
搜索选项。格式:array('key0'=>'value0', 'key1'=>'value1', ....)。支持的key:
- q string 搜索的关键字,必须进行URLencode。
- snick int 搜索范围是否包含昵称,0:不包含、1:包含。
- sdomain int 搜索范围是否包含个性域名,0:不包含、1:包含。
- sintro int 搜索范围是否包含简介,0:不包含、1:包含。
- stag int 搜索范围是否包含标签,0:不包含、1:包含。
- province int 搜索的省份范围,省份ID。
- city int 搜索的城市范围,城市ID。
- gender string 搜索的性别范围,m:男、f:女。
- comorsch string 搜索的公司学校名称。
- sort int 排序方式,1:按更新时间、2:按粉丝数,默认为1。
- count int 单页返回的记录条数,默认为10。
- page int 返回结果的页码,默认为1。
- base_app int 是否只获取当前应用的数据。0为否(所有数据),1为是(仅当前应用),默认为0。
以上所有参数全部选填
Returns
array
|
public
array
|
#
hot_users( string $category = "default" )
获取系统推荐用户
返回系统推荐的用户列表。
对应API:suggestions/users/hot
Parameters
- $category
分类,可选参数,返回某一类别的推荐用户,默认为 default。如果不在以下分类中,返回空列表:
- default:人气关注
- ent:影视名星
- hk_famous:港台名人
- model:模特
- cooking:美食&健康
- sport:体育名人
- finance:商界名人
- tech:IT互联网
- singer:歌手
- writer:作家
- moderator:主持人
- medium:媒体总编
- stockplayer:炒股高手
Returns
array
|
public
array
|
|
public
array
|
|
public
array
|
|