Direct messages

跳转到: 导航, 搜索
 
(未显示7个用户的18个中间版本)
第1行: 第1行:
== direct_messages ==
+
{{api_desc2|
返回用户的最新20条私信。XML和JSON的版本有发送者和接受者的详细资料。
+
uri=direct_messages|
 
+
desc=返回登录用户的最新收到的n条私信,每条私信包含发送者和接受者的详细信息。|
=== URL===
+
format=XML/JSON|
curl http://api.t.sina.com.cn/direct_messages.format
+
httpMethod=GET|
 +
needAuth=true|
 +
rateLimit=true|
 +
params={{api_args|since_id|false|int64|若指定此参数,则只返回ID比since_id大的记录(比since_id发送时间晚)。}}
 +
{{api_args|max_id|false|int64|若指定此参数,则返回ID小于或等于max_id的记录}}
 +
{{api_args|count|false|int,默认值20,最大值200。|单页返回的记录条数。}}
 +
{{api_args|page|false|int,默认值1。|返回结果的页码。}}|
 +
getParam=&count=5&page=2|
 +
postParam=|
 +
result=
 +
===XML示例===
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<direct-messages>
 +
  <direct_message>
 +
    <created_at>Fri Dec 03 14:30:01 +0800 2010</created_at>
 +
    <id>710275891</id>
 +
    <text>你参加的 "圈内招聘" 微群( http://sinaurl.cn/hbPhiL )被设置为 封闭 群组</text>
 +
    <sender_id>1821898647</sender_id>
 +
    <recipient_id>1658122963</recipient_id>
 +
    <sender_screen_name>微群小助手</sender_screen_name>
 +
    <recipient_screen_name>zhangwei217245</recipient_screen_name>
 +
    <sender>
 +
      <id>1821898647</id>
 +
      <screen_name>微群小助手</screen_name>
 +
      <name>微群小助手</name>
 +
      <province>11</province>
 +
      <city>8</city>
 +
      <location>北京 海淀区</location>
 +
      <description>新浪微群官方帐号!顶部导航【微群】可直接进入微群页面。您有任何意见或者建议,可随时@微群小助手 私信完全开放。合作或疑问请联系13810888467</description>
 +
      <url>http://q.t.sina.com.cn/</url>
 +
      <profile_image_url>http://tp4.sinaimg.cn/1821898647/50/1290508563/0</profile_image_url>
 +
      <domain/>
 +
      <gender>f</gender>
 +
      <followers_count>6799</followers_count>
 +
      <friends_count>12</friends_count>
 +
      <statuses_count>53</statuses_count>
 +
      <favourites_count>0</favourites_count>
 +
      <created_at>Mon Sep 20 00:00:00 +0800 2010</created_at>
 +
      <following>false</following>
 +
      <verified>true</verified>
 +
      <allow_all_act_msg>true</allow_all_act_msg>
 +
      <geo_enabled>true</geo_enabled>
 +
    </sender>
 +
    <recipient>
 +
      <id>1658122963</id>
 +
      <screen_name>zhangwei217245</screen_name>
 +
      <name>zhangwei217245</name>
 +
      <province>11</province>
 +
      <city>5</city>
 +
      <location>北京 朝阳区</location>
 +
      <description>ABCDE</description>
 +
      <url/>
 +
      <profile_image_url>http://tp4.sinaimg.cn/1658122963/50/1282754213</profile_image_url>
 +
      <domain>zhangwei217245</domain>
 +
      <gender>m</gender>
 +
      <followers_count>24</followers_count>
 +
      <friends_count>44</friends_count>
 +
      <statuses_count>118</statuses_count>
 +
      <favourites_count>3</favourites_count>
 +
      <created_at>Tue Nov 03 00:00:00 +0800 2009</created_at>
 +
      <following>false</following>
 +
      <verified>false</verified>
 +
      <allow_all_act_msg>false</allow_all_act_msg>
 +
      <geo_enabled>true</geo_enabled>
 +
    </recipient>
 +
  </direct_message>
 +
  ...
 +
</direct-messages>
 +
</pre>
 +
===JSON示例===
 +
<pre>
 +
[
 +
    {
 +
        "sender_screen_name" : "微群小助手",
 +
        "recipient_screen_name" : "zhangwei217245",
 +
        "text" : "你参加的 \"圈内招聘\" 微群( http://sinaurl.cn/hbPhiL )被设置为 封闭 群组",
 +
        "recipient" :
 +
        {
 +
            "name" : "zhangwei217245",
 +
            "domain" : "zhangwei217245",
 +
            "geo_enabled" : true,
 +
            "followers_count" : 24,
 +
            "statuses_count" : 118,
 +
            "favourites_count" : 3,
 +
            "city" : "5",
 +
            "description" : "ABCDE",
 +
            "verified" : false,
 +
            "id" : 1658122963,
 +
            "gender" : "m",
 +
            "friends_count" : 44,
 +
            "screen_name" : "zhangwei217245",
 +
            "allow_all_act_msg" : false,
 +
            "following" : false,
 +
            "url" : "",
 +
            "profile_image_url" : "http://tp4.sinaimg.cn/1658122963/50/1282754213",
 +
            "created_at" : "Tue Nov 03 00:00:00 +0800 2009",
 +
            "province" : "11",
 +
            "location" : "北京 朝阳区"
 +
        },
 +
        "sender" :
 +
        {
 +
            "name" : "微群小助手",
 +
            "domain" : "",
 +
            "geo_enabled" : true,
 +
            "followers_count" : 6799,
 +
            "statuses_count" : 53,
 +
            "favourites_count" : 0,
 +
            "city" : "8",
 +
            "description" : "新浪微群官方帐号!顶部导航【微群】可直接进入微群页面。您有任何意见或者建议,可随时@微群小助手 私信完全开放。合作或疑问请联系13810888467",
 +
            "verified" : true,
 +
            "id" : 1821898647,
 +
            "gender" : "f",
 +
            "friends_count" : 12,
 +
            "screen_name" : "微群小助手",
 +
            "allow_all_act_msg" : true,
 +
            "following" : false,
 +
            "url" : "http://q.t.sina.com.cn/",
 +
            "profile_image_url" : "http://tp4.sinaimg.cn/1821898647/50/1290508563/0",
 +
            "created_at" : "Mon Sep 20 00:00:00 +0800 2010",
 +
            "province" : "11",
 +
            "location" : "北京 海淀区"
 +
        },
 +
        "sender_id" : 1821898647,
 +
        "recipient_id" : 1658122963,
 +
        "id" : 710275891,
 +
        "created_at" : "Fri Dec 03 14:30:01 +0800 2010"
 +
    },
 +
...
 +
]
 +
</pre>
 +
{{param_DM}}
 +
{{param_user}}|
 +
useAge=无|
 +
otherInfo=
 +
===Java示例===
 +
请从 [[SDK | 微博SDK开发包下载]] 下载Java SDK<br>
 +
代码示例如下:
 +
package weibo4j.examples;
 
   
 
   
=== 格式===
+
import weibo4j.DirectMessage;
xml, json, rss, atom
+
import weibo4j.Weibo;
 +
import weibo4j.WeiboException;
 +
import java.util.List;
 
   
 
   
=== HTTP请求方式===
+
  public class GetDirectMessages{
GET
+
   
+
=== 是否需要身份验证===
+
true
+
 
+
=== 请求数限制===
+
1 call per request
+
 
+
=== 请求参数===
+
* since_id. 可选参数.  返回ID比数值since_id大(比since_id时间晚的)的私信。
+
o Example: http://api.t.sina.com.cn/direct_messages.xml?since_id=12345
+
* max_id. 可选参数.  返回ID不大于max_id(时间不晚于max_id)的私信。
+
o Example: http://api.t.sina.com.cn/direct_messages.xml?max_id=54321
+
* count.  可选参数.  每次返回的最大记录数(即页面大小),不大于200。 
+
o Example: http://api.t.sina.com.cn/direct_messages.xml?count=200
+
* page.  可选参数. 返回结果的页序号。注意:有分页限制。
+
o Example: http://api.t.sina.com.cn/direct_messages.xml?page=3
+
 
+
=== 返回 ===
+
XML示例:
+
<?xml version="1.0" encoding="UTF-8"?>
+
<direct-messages>
+
  <direct_message>
+
  <id>88619848</id>
+
  <sender_id>1401881</sender_id>
+
  <text>all your bases are belong to us.</text>
+
  <recipient_id>7004322</recipient_id>
+
  <created_at>Wed Apr 08 20:30:04 +0000 2009</created_at>
+
  <sender_screen_name>dougw</sender_screen_name>
+
  <recipient_screen_name>igudo</recipient_screen_name>
+
  <sender>
+
    <id>1401881</id>
+
    <name>Doug Williams</name>
+
    <screen_name>dougw</screen_name>
+
    <location>San Francisco, CA</location>
+
    <description>Sina API Support. Internet, greed, users, dougw and opportunities are my passions.</description>
+
    <profile_image_url>http://sinaimg.cn/avatar.png</profile_image_url>
+
    <url>http://www.igudo.com</url>
+
    <protected>false</protected>
+
    <followers_count>1036</followers_count>
+
    <profile_background_color>9ae4e8</profile_background_color>
+
    <profile_text_color>000000</profile_text_color>
+
    <profile_link_color>0000ff</profile_link_color>
+
    <profile_sidebar_fill_color>e0ff92</profile_sidebar_fill_color>
+
    <profile_sidebar_border_color>87bc44</profile_sidebar_border_color>
+
    <friends_count>290</friends_count>
+
    <created_at>Sun Mar 18 06:42:26 +0000 2007</created_at>
+
    <favourites_count>0</favourites_count>
+
    <utc_offset>-18000</utc_offset>
+
    <time_zone>Eastern Time (US & Canada)</time_zone>
+
   
+
    <profile_background_tile>false</profile_background_tile>
+
    <statuses_count>3394</statuses_count>
+
    <notifications>false</notifications>
+
    <following>false</following>
+
    <verified>true</verified>
+
  </sender>
+
  <recipient>
+
    <id>7004322</id>
+
    <name>Doug Williams</name>
+
    <screen_name>igudo</screen_name>
+
    <location>North Carolina</location>
+
    <description>A character.</description>
+
    <profile_image_url>http://s3.amazonaws.com/twitter_production/profile_images/15446222/twitter_48_48_normal.jpg</profile_image_url>
+
    <url>http://www.igudo.com</url>
+
    <protected>false</protected>
+
    <followers_count>19</followers_count>
+
    <profile_background_color>69A1AA</profile_background_color>
+
    <profile_text_color>000000</profile_text_color>
+
    <profile_link_color>F00</profile_link_color>
+
    <profile_sidebar_fill_color>ACBEC1</profile_sidebar_fill_color>
+
    <profile_sidebar_border_color>8A8F85</profile_sidebar_border_color>
+
    <friends_count>3</friends_count>
+
    <created_at>Thu Jun 21 21:16:21 +0000 2007</created_at>
+
    <favourites_count>0</favourites_count>
+
    <utc_offset>-18000</utc_offset>
+
    <time_zone>Eastern Time (US & Canada)</time_zone>
+
    <profile_background_image_url>http://static.twitter.com/images/themes/theme1/bg.gif</profile_background_image_url>
+
    <profile_background_tile>false</profile_background_tile>
+
    <statuses_count>382</statuses_count>
+
    <notifications>false</notifications>
+
    <following>true</following>
+
    <verified>true</verified>
+
  </recipient>
+
  </direct_message>
+
    ... truncated ...
+
</direct-messages>
+
 
   
 
   
=== 使用示例===
+
public static void main(String[] args) {
cURL:
+
if (args.length < 2) {
 +
System.out.println("No WeiboID/Password specified.");
 +
System.out.println("Usage: java weibo4j.examples.GetDirectMessages ID Password");
 +
System.exit(-1);
 +
}
 +
Weibo weibo = new Weibo(args[0], args[1]);
 +
try {
 +
List<DirectMessage> messages = weibo.getDirectMessages();
 +
for (DirectMessage message : messages) {
 +
System.out.println("Sender:" + message.getSenderScreenName());
 +
System.out.println("Text:" + message.getText() + "\n");
 +
}
 +
System.exit(0);
 +
} catch (WeiboException te) {
 +
System.out.println("Failed to get messages: " + te.getMessage());
 +
System.exit(-1);
 +
}
 +
}
 +
}
 +
===PHP示例===
 +
请从 [[SDK | 微博SDK开发包下载]] 处下载PHP SDK(支持OAuth验证之版本)<br>
 +
代码示例如下:
 +
<pre>
 +
//direct_messages
 +
$c = new WeiboClient( WB_AKEY ,
 +
                      WB_SKEY ,
 +
                      $_SESSION['last_key']['oauth_token'] ,
 +
                      $_SESSION['last_key']['oauth_token_secret']  );
  
curl -u user:password http://api.t.sina.com.cn/direct_messages.xml
+
$msg = $c->list_dm();
 +
if ($msg === false || $msg === null){
 +
echo "Error occured";
 +
return false;
 +
}
 +
if (isset($msg['error_code']) && isset($msg['error'])){
 +
echo ('Error_code: '.$msg['error_code'].';  Error: '.$msg['error'] );
 +
return false;
 +
}
 +
foreach($msg as $mail){
 +
echo('Sender: '.$mail['sender_screen_name'].'  Text: '.$mail['text'].' ; ');
 +
}
 +
</pre>
 +
}}

2010年12月6日 (一) 10:58的最后版本

目录

direct_messages

返回登录用户的最新收到的n条私信,每条私信包含发送者和接受者的详细信息。

URL

http://api.t.sina.com.cn/direct_messages.(json%7Cxml)

支持格式

XML/JSON

HTTP请求方式

GET

是否需要登录

true
关于授权机制,参见授权机制声明

请求数限制

true
关于请求数限制,参见接口访问权限说明

请求参数

  必选 类型及范围 说明
source true string 申请应用时分配的AppKey,调用接口时候代表应用的唯一身份。(采用OAuth授权方式不需要此参数)
since_id false int64 若指定此参数,则只返回ID比since_id大的记录(比since_id发送时间晚)。
max_id false int64 若指定此参数,则返回ID小于或等于max_id的记录
count false int,默认值20,最大值200。 单页返回的记录条数。
page false int,默认值1。 返回结果的页码。

注意事项

返回结果

XML示例

<?xml version="1.0" encoding="UTF-8"?>
<direct-messages>
  <direct_message>
    <created_at>Fri Dec 03 14:30:01 +0800 2010</created_at>
    <id>710275891</id>
    <text>你参加的 "圈内招聘" 微群( http://sinaurl.cn/hbPhiL )被设置为 封闭 群组</text>
    <sender_id>1821898647</sender_id>
    <recipient_id>1658122963</recipient_id>
    <sender_screen_name>微群小助手</sender_screen_name>
    <recipient_screen_name>zhangwei217245</recipient_screen_name>
    <sender>
      <id>1821898647</id>
      <screen_name>微群小助手</screen_name>
      <name>微群小助手</name>
      <province>11</province>
      <city>8</city>
      <location>北京 海淀区</location>
      <description>新浪微群官方帐号!顶部导航【微群】可直接进入微群页面。您有任何意见或者建议,可随时@微群小助手 私信完全开放。合作或疑问请联系13810888467</description>
      <url>http://q.t.sina.com.cn/</url>
      <profile_image_url>http://tp4.sinaimg.cn/1821898647/50/1290508563/0</profile_image_url>
      <domain/>
      <gender>f</gender>
      <followers_count>6799</followers_count>
      <friends_count>12</friends_count>
      <statuses_count>53</statuses_count>
      <favourites_count>0</favourites_count>
      <created_at>Mon Sep 20 00:00:00 +0800 2010</created_at>
      <following>false</following>
      <verified>true</verified>
      <allow_all_act_msg>true</allow_all_act_msg>
      <geo_enabled>true</geo_enabled>
    </sender>
    <recipient>
      <id>1658122963</id>
      <screen_name>zhangwei217245</screen_name>
      <name>zhangwei217245</name>
      <province>11</province>
      <city>5</city>
      <location>北京 朝阳区</location>
      <description>ABCDE</description>
      <url/>
      <profile_image_url>http://tp4.sinaimg.cn/1658122963/50/1282754213</profile_image_url>
      <domain>zhangwei217245</domain>
      <gender>m</gender>
      <followers_count>24</followers_count>
      <friends_count>44</friends_count>
      <statuses_count>118</statuses_count>
      <favourites_count>3</favourites_count>
      <created_at>Tue Nov 03 00:00:00 +0800 2009</created_at>
      <following>false</following>
      <verified>false</verified>
      <allow_all_act_msg>false</allow_all_act_msg>
      <geo_enabled>true</geo_enabled>
    </recipient>
  </direct_message>
  ...
</direct-messages>

JSON示例

[
    {
        "sender_screen_name" : "微群小助手",
        "recipient_screen_name" : "zhangwei217245",
        "text" : "你参加的 \"圈内招聘\" 微群( http://sinaurl.cn/hbPhiL )被设置为 封闭 群组",
        "recipient" : 
        {
            "name" : "zhangwei217245",
            "domain" : "zhangwei217245",
            "geo_enabled" : true,
            "followers_count" : 24,
            "statuses_count" : 118,
            "favourites_count" : 3,
            "city" : "5",
            "description" : "ABCDE",
            "verified" : false,
            "id" : 1658122963,
            "gender" : "m",
            "friends_count" : 44,
            "screen_name" : "zhangwei217245",
            "allow_all_act_msg" : false,
            "following" : false,
            "url" : "",
            "profile_image_url" : "http://tp4.sinaimg.cn/1658122963/50/1282754213",
            "created_at" : "Tue Nov 03 00:00:00 +0800 2009",
            "province" : "11",
            "location" : "北京 朝阳区"
        },
        "sender" : 
        {
            "name" : "微群小助手",
            "domain" : "",
            "geo_enabled" : true,
            "followers_count" : 6799,
            "statuses_count" : 53,
            "favourites_count" : 0,
            "city" : "8",
            "description" : "新浪微群官方帐号!顶部导航【微群】可直接进入微群页面。您有任何意见或者建议,可随时@微群小助手 私信完全开放。合作或疑问请联系13810888467",
            "verified" : true,
            "id" : 1821898647,
            "gender" : "f",
            "friends_count" : 12,
            "screen_name" : "微群小助手",
            "allow_all_act_msg" : true,
            "following" : false,
            "url" : "http://q.t.sina.com.cn/",
            "profile_image_url" : "http://tp4.sinaimg.cn/1821898647/50/1290508563/0",
            "created_at" : "Mon Sep 20 00:00:00 +0800 2010",
            "province" : "11",
            "location" : "北京 海淀区"
        },
        "sender_id" : 1821898647,
        "recipient_id" : 1658122963,
        "id" : 710275891,
        "created_at" : "Fri Dec 03 14:30:01 +0800 2010"
    },
...
]

字段说明 - direct_message

  • id: 私信ID
  • text: 私信内容
  • sender_id:发送人UID
  • recipient_id: 接受人UID
  • created_at: 发送时间
  • sender_screen_name: 发送人昵称
  • recipient_screen_name:接受人昵称
  • sender: 发送人信息,参考user说明
  • recipient: 接受人信息,参考user说明

字段说明 - user

  • id: 用户UID
  • screen_name: 微博昵称
  • name: 友好显示名称,同微博昵称
  • province: 省份编码(参考省份编码表)
  • city: 城市编码(参考城市编码表)
  • location:地址
  • description: 个人描述
  • url: 用户博客地址
  • profile_image_url: 自定义图像
  • domain: 用户个性化URL
  • gender: 性别,m--男,f--女,n--未知
  • followers_count: 粉丝数
  • friends_count: 关注数
  • statuses_count: 微博数
  • favourites_count: 收藏数
  • created_at: 创建时间
  • following: 是否已关注(此特性暂不支持)
  • verified: 加V标示,是否微博认证用户

其他

Java示例

请从 微博SDK开发包下载 下载Java SDK
代码示例如下:

package weibo4j.examples;

import weibo4j.DirectMessage;
import weibo4j.Weibo;
import weibo4j.WeiboException;
import java.util.List;

public class GetDirectMessages{

	public static void main(String[] args) {
		if (args.length < 2) {
			System.out.println("No WeiboID/Password specified.");
			System.out.println("Usage: java weibo4j.examples.GetDirectMessages ID Password");
			System.exit(-1);
		}
		Weibo weibo = new Weibo(args[0], args[1]);
		try {
			List<DirectMessage> messages = weibo.getDirectMessages();
			for (DirectMessage message : messages) {
				System.out.println("Sender:" + message.getSenderScreenName());
				System.out.println("Text:" + message.getText() + "\n");
			}
			System.exit(0);
		} catch (WeiboException te) {
			System.out.println("Failed to get messages: " + te.getMessage());
			System.exit(-1);
		}
	}
}

PHP示例

请从 微博SDK开发包下载 处下载PHP SDK(支持OAuth验证之版本)
代码示例如下:

//direct_messages
$c = new WeiboClient( WB_AKEY , 
                      WB_SKEY , 
                      $_SESSION['last_key']['oauth_token'] , 
                      $_SESSION['last_key']['oauth_token_secret']  );

$msg = $c->list_dm();
if ($msg === false || $msg === null){
	echo "Error occured";
	return false;
}
if (isset($msg['error_code']) && isset($msg['error'])){
	echo ('Error_code: '.$msg['error_code'].';  Error: '.$msg['error'] );
	return false;
}
foreach($msg as $mail){
	echo('Sender: '.$mail['sender_screen_name'].'  Text: '.$mail['text'].' ; ');
}
文档更新时间: 2010-12-06