豆瓣广播 Api V2

回Api V2 首页

注:广播所有的API操作都需要登录。

发送一条广播

说明

发布一条广播信息。请求必须用POST方式提交。
豆瓣广播类型繁多,但是对外只支持‘我说’(可带图)和‘推荐网址’两种。

URL

shuo/v2/statuses/

支持格式

JSON

HTTP请求方式

POST
’我说‘类型的广播中如果需要附带图片,注意采用multipart/form-data编码方式上传,上传图片大小限制为<3M,仅支持JPEG,GIF,PNG图片,name 是 image

请求参数

必选类型及范围说明
sourcetruestringappkey
texttruestring广播文本内容
imagefalsebytes我说的图
rec_titlefalsestring推荐网址的标题
rec_urlfalsestring推荐网址的href
rec_descfalsestring推荐网址的描述
rec_imagefalsestring推荐网址的附图url

注意:

1. image参数一定是我说带的图, 无法作为推荐时带的图, 推荐附图请使用rec_image参数
2. 有image的情况下rec系列参数都会被忽略。
3. 由于原来的attachments参数过于繁琐, 以后已经不建议使用, 而它也只有在image参数和rec系列参数都不传的情况下才会生效。

调用示例

curl "https://api.douban.com/shuo/v2/statuses/" -H "Authorization: Bearer TOKEN"  -F "text=TestText"  -F "image=@upload.png"

返回结果

发送成功的广播数据

获取当前登录用户及其所关注用户的最新广播(友邻广播)

说明

获取当前登录用户及其所关注用户的最新广播消息。

URL

shuo/v2/statuses/home_timeline

支持格式

JSON

HTTP请求方式

GET

请求参数

必选类型及范围说明
since_idfalseint64若指定此参数,则只返回ID比since_id大的广播消息(即比since_id发表时间晚的广播消息)。
until_idfalseint64若指定此参数,则返回ID小于或等于until_id的广播消息
countfalseint默认20,最大200
startfalseint默认0

调用示例

shuo/v2/statuses/home_timeline?until_id=1006254272

返回结果

广播列表 示例请登录后点击这里

获取用户发布的广播列表

说明

返回用户最新发表的广播消息列表。

URL

shuo/v2/statuses/user_timeline/:user_id
或者:
shuo/v2/statuses/user_timeline/:screen_name

支持格式

JSON

HTTP请求方式

GET

请求参数

必选类型及范围说明
since_idfalseint64若指定此参数,则只返回ID比since_id大(即比since_id发表时间晚的)的广播消息。
until_idfalseint64若指定此参数,则返回ID小于或等于until_id的广播消息

* 如果:id、user_id、screen_name三个参数均未指定,则返回当前登录用户最近发表的广播消息列表。*

调用示例

shuo/v2/statuses/user_timeline/2770683
shuo/v2/statuses/user_timeline/ahbei

返回结果(JSON示例)

广播列表 示例可点击这里

单条广播接口

读取(或者删除)一条广播

说明

1. 读取一条广播
2. 删除一条广播

URL

shuo/v2/statuses/:id

支持格式

JSON

HTTP请求方式

GET/DELETE
  • GET 为获取单条广播内容

  • DELETE 为删除单条广播,只有删除自己的广播

请求参数

必选类型及范围说明
packfalsebool是否打包 resharers 和 comments 数据

调用示例

shuo/v2/statuses/:id

返回结果

1. 该条广播数据

当 pack 为真时:
2. {"status": 广播数据, "reshare_users": 转播的用户列表, "comments": 评论列表, "like_users": 赞的用户列表}

获取一条广播的回复列表 或者 添加一条评论

说明

操作一条广播的回复(包括获取评论列表和添加评论)

URL

shuo/v2/statuses/:id/comments

支持格式

JSON

HTTP请求方式

GET 返回一条广播的回复列表
支持参数:start, count

POST 回复一条广播

调用示例

shuo/v2/statuses/:id/comments

返回结果

POST: 返回comment 对象
GET: 返回comment对象列表

获取单条回复的内容或者删除该回复

说明

操作一条回复(获取其内容或者是删除)

URL

shuo/v2/statuses/comment/:id

支持格式

JSON

HTTP请求方式

GET/DELETE
  • GET 为获取单条回复内容(可能没用)
  • DELETE 为删除单条回复,楼主、发帖人、管理员能删除

调用示例

shuo/v2/statuses/comment/:id

返回结果

该条comment数据(包含相关的statuses)

转播

说明

1. 获取一条广播的转发相关信息 GET
2. 转播一条广播信息。请求必须用POST方式提交。
3. 取消转播等价于删除一条广播

URL

shuo/v2/statuses/:id/reshare

支持格式

JSON

HTTP请求方式

GET  获取最近转播的用户列表
POST 转播

调用示例

shuo/v2/statuses/:id/reshare

返回结果

发送成功的广播数据

说明

1. 获取一条广播的赞相关信息 GET
2. 赞一条广播 POST
3. 取消赞 DELETE

URL

shuo/v2/statuses/:id/like

支持格式

JSON

HTTP请求方式

+ GET  获取最近赞的用户列表
+ POST 赞
+ DELETE 取消赞

调用示例

shuo/v2/statuses/:id/like

返回结果

对应的广播数据

用户接口

获取用户关注列表

说明

返回一个用户follow的用户列表

URL

shuo/v2/users/:id/following
  • 支持格式 *

    JSON

  • HTTP请求方式 *

    GET

  • 请求参数 *

    必选类型及范围说明
    tagfalseint该tag的id
  • 调用示例 *

    shuo/v2/users/:id/following

返回结果

返回一个用户follow的用户列表

获取用户关注者列表

说明

返回follow一个用户的用户列表

URL

shuo/v2/users/:id/followers
  • 支持格式 *

    JSON

  • HTTP请求方式 *

    GET

  • 调用示例 *

    shuo/v2/users/:id/followers

返回结果

返回follow一个用户的用户列表

获取共同关注的用户列表

说明

返回共同关注的用户列表

URL

shuo/v2/users/:id/follow_in_common
  • 支持格式 *

    JSON

  • HTTP请求方式 *

    GET

  • 调用示例 *

    shuo/v2/users/:id/follow_in_common

返回结果

返回共同关注的用户列表

获取关注的人关注了该用户的列表

说明

返回当前用户关注的人中也关注了该用户的列表

URL

shuo/v2/users/:id/following_followers_of
  • 支持格式 *

    JSON

  • HTTP请求方式 *

    GET

  • 调用示例 *

    shuo/v2/users/:id/following_followers_of

返回结果

返回当前用户关注的人中也关注了该用户的列表

搜索用户

说明

搜索用户

URL

shuo/v2/users/search
  • 支持格式 *

    JSON

  • HTTP请求方式 *

    GET

  • 请求参数 *

必选类型及范围说明
qtruestring搜索字符串
  • 调用示例 *

    shuo/v2/users/search?q=ahbei

返回结果

返回符合要求的user列表

block用户

说明

将指定用户加入黑名单

URL

shuo/v2/users/:id/block
  • 支持格式 *

    JSON

  • HTTP请求方式 *

    POST

  • 请求参数 *

必选类型及范围说明
user_idtruestring用户 ID
  • 调用示例 *

    shuo/v2/users/:id/block

返回结果

  • 成功:{"r": 1}
  • 失败:{"r": 0}

关系接口

建立关注

说明

follow一个用户

URL

shuo/v2/friendships/create
  • 支持格式 *

    JSON

  • HTTP请求方式 *

    POST

  • 请求参数 *

必选类型及范围说明
sourcetruestringappkey
user_idtruestring用户id

返回结果

发送follow用户的user对象

取消关注

说明

unfollow一个用户

URL

shuo/v2/friendships/destroy
  • 支持格式 *

    JSON

  • HTTP请求方式 *

    POST

  • 请求参数 *

必选类型及范围说明
sourcetruestringappkey
user_idtruestring用户id

返回结果

发送unfollow用户的user对象

获取两个用户的关系

说明

follow一个用户

URL

shuo/v2/friendships/show
  • 支持格式 *

    JSON

  • HTTP请求方式 *

    GET

  • 请求参数 *

必选类型及范围说明
sourcetruestringappkey
source_idtruestring用户id
target_idtruestring用户id

其中source_id如果没有,则使用当前用户

返回结果

{
 "source": {
    "id": "3407397647969193784",
    "screen_name": "Tux",
    "following": false,
    "followed_by": true
    },
 "target": {
    "id": "-7325997749471485394",
    "screen_name": "001",
    "following": true,
    "followed_by": false
    }
}

返回的各对象的说明

  • 广播对象 *
类型及范围说明
idstring广播id
userJSON string发广播者
titlestring广播的title, 如:推荐网址
textstringweb段在引号内展示的一段文本, 一般为用户输入的内容
attachmentsJSON string请参见发送一条广播的API中对attachments的说明
sourceJSON stringapp key对应的应用名和应用url
reshared_countint转播数
like_countint赞的数量
comments_countint回应数
can_replybool是否可被回应
likedbool是否已经喜欢
created_atstring发广播的时间
reshared_statusJSON string转播的广播对象,这个属性只有在当前广播是一条转播的条件下才会有
  • 用户对象 *
类型及范围说明
idstring用户id
uidstring用户域名
screen_namestring用户名号
icon_avatarstring用户头像

attachments

attachments是一个json array格式的字符串, array里面的元素称为物, 目前每条广播只支持单个物,物是每条广播表述的行为中的那个宾语,例如: xx推荐网址, 网址就是这个‘物’, 它的结构如下:

title标题,如果传空,会显示‘无标题’, 最大长度100字节(50汉字或100字母)
href链接,url最大长度1024,需要分析并展示网站域名
description描述,可以为空,最大长度200字节(100汉字或200字母)
media富媒体,允许 image, flash, music 单条广播所有[[BR]]图片无最小值限制,文件最大不超过3M[[BR]]缩略图:最大边150px[[BR]]点击展开后:宽度最大460px,高度不限[[BR]]原图大小无宽高限制
caption子标题
type分类,预留字段
properties如果有分类,这里存放对应类别的详细数据,具体的字段由该类别自行定义

== media 类型 ==

image

{"media":[
    { 
        "src": "http://icanhascheezburger.files.wordpress.com/2009/03/funny-pictures-kitten-finished-his-milk-and-wants-a-cookie.jpg", 
        "href": "http://icanhascheezburger.com/2009/03/30/funny-pictures-awlll-gone-cookie-now/",
        "type: "image",
        "sizes": {"small": [160, 160], "media": [400, 900], "raw": [700, 1000]}
    }, 
    {
        "src": "http://photos.icanhascheezburger.com/completestore/2009/1/18/128768048603560273.jpg", 
        "href": "http://ihasahotdog.com/upcoming/?pid=20869",
        "type: "image"
    }]
}

flash

{"media": [{
    "src": "http://www.mapsofwar.com/photos/EMPIRE17.swf", 
    "imgsrc": "http://icanhascheezburger.files.wordpress.com/2009/04/funny-pictures-hairless-cat-phones-    home.jpg", 
    "type": "flash"
}]
}

music

{"media":[{
    "src": "http://www.looptvandfilm.com/blog/Radiohead%20-%20In%20Rainbows/01%20-      %20Radiohead%20-%2015%20Step.MP3", 
    "title": "15 Step", 
    "artist": "Radiohead", 
    "album": "In Rainbows",
    "type": "music"
}]
}

回Api V2 首页