API函数 说明.docx

API函数 说明.docx

《API函数 说明.docx》由会员分享，可在线阅读，更多相关《API函数 说明.docx（22页珍藏版）》请在冰豆网上搜索。

API函数说明

目录

API方法说明4

1、消息相关的方法4

1.1显示随便看看的消息4

1.2显示用户和好友的消息4

1.3显示用户的消息5

1.4显示指定消息6

1.5显示发给当前用户的消息6

1.6发布消息6

1.7删除消息7

1.8他人转发的微博7

1.9我转发的微博8

1.10我被转发的微博9

1.11转发消息9

2、搜索相关的方法10

2.1公开搜索10

3、用户相关的方法10

3.1显示好友列表10

3.2显示关注者列表11

3.3显示用户详细信息11

3.4推荐用户列表11

4、私信相关的方法11

4.1显示用户收到的私信11

4.2显示用户发的私信12

4.3发送私信12

4.4删除私信13

5、收藏相关的方法13

5.1显示用户的收藏列表13

5.2收藏某条消息13

5.3删除收藏14

6、好友关系方法14

6.1添加好友14

6.2删除好友14

6.3判断好友关系是否存在15

7、好友和关注者方法15

7.1显示好友id列表15

7.2显示关注者id列表15

8、账号方法15

8.1验证用户16

8.2修改用户头像16

8.3修改用户基本信息16

9、返回的参数模块16

9.1消息模块17

9.2用户基本信息模块17

9.3用户扩展信息模块18

9.4私信模块18

9.5转发消息模块19

9.6推荐消息模块20

10、返回的参数属性值21

10.1created_at21

10.2description21

10.3favorited21

10.4favorites_count22

10.5following22

10.6followers_count22

10.7friends_count22

10.8name22

10.9id22

10.10in_reply_to_screen_name23

10.11in_reply_to_status_id23

10.12in_reply_to_user_id23

10.13location23

10.14notifications23

10.15profile_image_url23

10.16protected24

10.17screen_name24

10.18source24

10.19statuses_count24

10.20text24

10.21truncated24

10.22url24

API方法说明

1、消息相关的方法

1.1显示随便看看的消息

路径：

http：

//

参数：

∙count（可选）-消息数，范围1-20，默认为20。

示例：

∙format（可选）－消息内容格式，当format=html时，返回消息的内容字段是进行@识别，网址识别等后台处理之后的html代码。

∙callback（可选）-JavaScript函数名，使用JSON格式时可用，将JSON对象作为参数直接调用

示例：

1.2显示用户和好友的消息

路径：

参数：

∙id-用户id，没有此参数或用户设隐私时需验证用户。

有此参数时返回的是此用户和好友的所有消息，没有此参数时返回的是当前用户的首页中的最新消息。

（注明歧义）

示例：

∙count（可选）-消息数，范围1-20，默认为20。

示例：

∙since_id（可选）-仅返回比此ID大的消息。

示例：

&id=333

∙max_id（可选）-仅返回ID小于等于此ID的消息。

示例：

∙page（可选）-页码，从1开始

示例：

∙format（可选）－消息内容格式，当format=html时，返回消息的内容字段是进行@识别，网址识别等后台处理之后的html代码。

∙callback（可选）-JavaScript函数名，使用JSON格式时可用，将JSON对象作为参数直接调用

示例：

1.3显示用户的消息

路径：

参数：

∙id（可选）-用户id，没有此参数或用户设隐私时需验证用户。

示例：

或

∙count（可选）-消息数，范围1-20，默认为20。

示例：

∙since_id（可选）-仅返回比此ID大的消息。

示例：

∙max_id（可选）-仅返回ID小于等于此ID的消息。

示例：

∙page（可选）-页码，从1开始

示例：

∙format（可选）－消息内容格式，当format=html时，返回消息的内容字段是进行@识别，网址识别等后台处理之后的html代码。

∙callback（可选）-JavaScript函数名，使用JSON格式时可用，将JSON对象作为参数直接调用

示例：

1.4显示指定消息

路径：

参数：

∙id（必需）-消息的id。

示例：

1.5显示发给当前用户的消息

路径：

参数：

∙count（可选）-消息数，范围1-20，默认为20。

示例：

∙since_id（可选）-仅返回比此ID大的消息。

示例：

∙max_id（可选）-仅返回ID小于等于此ID的消息。

示例：

∙page（可选）-页码，从1开始

示例：

∙format（可选）－消息内容格式，当format=html时，返回消息的内容字段是进行@识别，网址识别等后台处理之后的html代码。

1.6发布消息

路径：

方法：

POST

参数：

∙status（必需）-消息内容，使用POST方式提交

∙in_reply_to_status_id（可选）-如果是回复某一条消息，则在这里指明被回复的消息的ID。

∙source（可选）-消息来源，使用POST方式提交，如果与微博的数据库匹配，网页上将以此格式显示：

∙status（消息内容）通过source对应的API应用名称（参考上面的API应用认证相关说明）。

∙location（可选）-最多30个字符，表示发布消息的地点名称或一个半角逗号分隔的经纬度坐标。

如：

北京市海淀区或者39.9594049,116.298419。

1.7删除消息

路径：

方法：

POST

参数：

∙id（必需）-消息的id。

示例：

1.8他人转发的微博

　　路径：

　　需验证用户

　　参数：

∙count（可选）-消息数，范围1-20，默认为20。

　　示例：

∙since_id（可选）-仅返回比此ID大的消息。

　　示例：

∙max_id（可选）-仅返回ID小于等于此ID的消息。

　　示例：

∙page（可选）-页码，从1开始

　　示例：

∙format（可选）－消息内容格式，当format=html时，返回消息的内容字段是进行@识别，网址识别等后台处理之后的html代码。

∙callback（可选）-JavaScript函数名，使用JSON格式时可用，将JSON对象作为参数直接调用

　　示例：

1.9我转发的微博

　　路径：

　　需验证用户

　　参数：

∙count（可选）-消息数，范围1-20，默认为20。

　　示例：

∙since_id（可选）-仅返回比此ID大的消息。

　　示例：

∙max_id（可选）-仅返回ID小于等于此ID的消息。

　　示例：

∙page（可选）-页码，从1开始

　　示例：

∙format（可选）－消息内容格式，当format=html时，返回消息的内容字段是进行@识别，网址识别等后台处理之后的html代码。

∙callback（可选）-JavaScript函数名，使用JSON格式时可用，将JSON对象作为参数直接调用

　　示例：

1.10我被转发的微博

　　路径：

　　需验证用户

　　参数：

∙count（可选）-消息数，范围1-20，默认为20。

　　示例：

∙since_id（可选）-仅返回比此ID大的消息。

　　示例：

∙max_id（可选）-仅返回ID小于等于此ID的消息。

　　示例：

∙page（可选）-页码，从1开始

　　示例：

∙format（可选）－消息内容格式，当format=html时，返回消息的内容字段是进行@识别，网址识别等后台处理之后的html代码。

∙callback（可选）-JavaScript函数名，使用JSON格式时可用，将JSON对象作为参数直接调用

　　示例：

1.11转发消息

　　路径：

　　需验证用户

　　POST

　　参数：

∙id（必需）-消息的id。

　　示例：

2、搜索相关的方法

2.1公开搜索

路径：

　　参数：

∙q（必须）-检索串（缺省则为搜索空信息）。

∙cnfol–表示要搜索的值

　　示例：

或

∙max_id（可选）-仅返回ID小于此ID的消息。

　　示例：

3、用户相关的方法

3.1显示好友列表

路径：

参数：

∙id（可选）-用户id，没有此参数或用户设隐私时需验证用户。

示例：

或

∙page（可选）-页码，从1开始

示例：

3.2显示关注者列表

路径：

参数：

∙id（可选）-用户id，没有此参数或用户设隐私时需验证用户。

示例：

或

∙page（可选）-页码，从1开始

示例：

3.3显示用户详细信息

路径：

参数：

∙id（可选）-用户id，没有此参数或用户设隐私时需验证用户。

没有此参数时为当前用户。

示例：

或

3.4推荐用户列表

路径：

示例：

4、私信相关的方法

4.1显示用户收到的私信

路径：

参数：

∙count（可选）-私信数，范围1-20，默认为20。

示例：

∙since_id（可选）-仅返回比此ID大的私信。

示例：

∙max_id（可选）-仅返回ID小于等于此ID的私信。

示例：

∙page（可选）-页码，从1开始

示例：

4.2显示用户发的私信

路径：

参数：

∙count（可选）-私信数，范围1-20，默认为20。

示例：

∙since_id（可选）-仅返回比此ID大的私信。

示例：

∙max_id（可选）-仅返回ID小于等于此ID的私信。

示例：

∙page（可选）-页码，从1开始

示例：

4.3发送私信

路径：

方法：

POST

参数：

∙user（必需）-收信人用户名，使用POST方式提交

∙text（必需）-私信内容，使用POST方式提交

∙in_reply_to_id（可选）-表示回复某条私信

4.4删除私信

路径：

方法：

POST

参数：

∙id（必需）-私信的id。

示例：

或

5、收藏相关的方法

5.1显示用户的收藏列表

路径：

参数：

∙id（可选）-用户id，没有此参数或用户设隐私时需验证用户。

示例：

或