Direct messages/destroy

跳转到: 导航, 搜索
(创建新页面为 '== direct_messages/destroy == Destroys the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message.…')
 
 
(未显示7个用户的19个中间版本)
第1行: 第1行:
== direct_messages/destroy ==
+
{{api_desc2|
Destroys the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message.
+
uri=direct_messages/destroy/:id|
 +
desc=根据ID删除登录用户收到的私信。|
 +
format=XML/JSON|
 +
httpMethod=POST/DELETE|
 +
needAuth=true|
 +
rateLimit=true|
 +
params={{api_args|:id|true|int64|要删除的私信ID。}}|
 +
getParam=|
 +
postParam=-X DELETE|
 +
result=
 +
===XML示例===
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<direct_message>
 +
  <created_at>Mon Dec 06 11:35:37 +0800 2010</created_at>
 +
  <id>722778763</id>
 +
  <text>qwe</text>
 +
  <sender_id>1854740027</sender_id>
 +
  <recipient_id>1854835127</recipient_id>
 +
  <sender_screen_name>siegetest</sender_screen_name>
 +
  <recipient_screen_name>siegetest2</recipient_screen_name>
 +
  <sender>
 +
    <id>1854740027</id>
 +
    <screen_name>siegetest</screen_name>
 +
    <name>siegetest</name>
 +
    <province>11</province>
 +
    <city>8</city>
 +
    <location>北京 海淀区</location>
 +
    <description>ABCDE</description>
 +
    <url/>
 +
    <profile_image_url>http://tp4.sinaimg.cn/1854740027/50/1291272213/1</profile_image_url>
 +
    <domain/>
 +
    <gender>m</gender>
 +
    <followers_count>2</followers_count>
 +
    <friends_count>20</friends_count>
 +
    <statuses_count>18</statuses_count>
 +
    <favourites_count>0</favourites_count>
 +
    <created_at>Thu Nov 11 00:00:00 +0800 2010</created_at>
 +
    <following>false</following>
 +
    <verified>false</verified>
 +
    <allow_all_act_msg>false</allow_all_act_msg>
 +
    <geo_enabled>true</geo_enabled>
 +
  </sender>
 +
  <recipient>
 +
    <id>1854835127</id>
 +
    <screen_name>siegetest2</screen_name>
 +
    <name>siegetest2</name>
 +
    <province>11</province>
 +
    <city>8</city>
 +
    <location>北京 海淀区</location>
 +
    <description/>
 +
    <url/>
 +
    <profile_image_url>http://tp4.sinaimg.cn/1854835127/50/0/1</profile_image_url>
 +
    <domain/>
 +
    <gender>m</gender>
 +
    <followers_count>0</followers_count>
 +
    <friends_count>20</friends_count>
 +
    <statuses_count>2</statuses_count>
 +
    <favourites_count>0</favourites_count>
 +
    <created_at>Thu Nov 11 00:00:00 +0800 2010</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>
 +
</pre>
 +
===JSON示例===
 +
<pre>
 +
{
 +
    "sender_screen_name" : "zhangwei217245",
 +
    "recipient_screen_name" : "微博开放平台",
 +
    "text" : "Wow~~~Congratulations!",
 +
    "recipient" :
 +
    {
 +
        "name" : "微博开放平台",
 +
        "domain" : "openapi",
 +
        "geo_enabled" : true,
 +
        "followers_count" : 13366,
 +
        "statuses_count" : 158,
 +
        "favourites_count" : 0,
 +
        "city" : "8",
 +
        "description" : "新浪微博开放平台市场推广官方账号,如有技术问题,请@微博API或者发私信给微博API",
 +
        "verified" : true,
 +
        "status" :
 +
        {
 +
            "created_at" : "Mon Nov 29 16:08:43 +0800 2010",
 +
            "text" : "各位开发者,我们的论坛上线啦~http://sinaurl.cn/h4FWc7 欢迎大家的参与~另外,关于技术相关的问题,可以在论坛上提出,也可以@微博API 这个官方技术支持账号哦~感谢大家对开放平台的支持~[呵呵]",
 +
            "truncated" : false,
 +
            "in_reply_to_status_id" : "",
 +
            "in_reply_to_screen_name" : "",
 +
            "geo" : null,
 +
            "favorited" : false,
 +
            "in_reply_to_user_id" : "",
 +
            "id" : 3958728723,
 +
            "source" : "<a href=\"http://t.sina.com.cn\" rel=\"nofollow\">新浪微博</a>"
 +
        },
 +
        "id" : 11051,
 +
        "gender" : "m",
 +
        "friends_count" : 5,
 +
        "screen_name" : "微博开放平台",
 +
        "allow_all_act_msg" : true,
 +
        "following" : false,
 +
        "url" : "http://open.t.sina.com.cn/",
 +
        "profile_image_url" : "http://tp4.sinaimg.cn/11051/50/1280283165/1",
 +
        "created_at" : "Wed Jan 20 00:00:00 +0800 2010",
 +
        "province" : "11",
 +
        "location" : "北京 海淀区"
 +
    },
 +
    "sender" :
 +
    {
 +
        "name" : "zhangwei217245",
 +
        "domain" : "zhangwei217245",
 +
        "geo_enabled" : true,
 +
        "followers_count" : 24,
 +
        "statuses_count" : 118,
 +
        "favourites_count" : 3,
 +
        "city" : "5",
 +
        "description" : "ABCDE",
 +
        "verified" : false,
 +
        "status" :
 +
        {
 +
            "created_at" : "Sat Dec 04 23:35:20 +0800 2010",
 +
            "text" : "动物丛书的由来。。。http://sinaurl.cn/hbVjvr",
 +
            "truncated" : false,
 +
            "in_reply_to_status_id" : "",
 +
            "annotations" :
 +
            [
  
=== URL: ===
+
            ],
http://api.t.sina.com.cn/direct_messages/destroy/id.format
+
            "in_reply_to_screen_name" : "",
 +
            "geo" : null,
 +
            "favorited" : false,
 +
            "in_reply_to_user_id" : "",
 +
            "id" : 4087921127,
 +
            "source" : "<a href=\"http://t.sina.com.cn\" rel=\"nofollow\">新浪微博</a>"
 +
        },
 +
        "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_id" : 1658122963,
 +
    "recipient_id" : 11051,
 +
    "id" : 722715041,
 +
    "created_at" : "Mon Dec 06 11:21:31 +0800 2010"
 +
}
 +
</pre>
 +
{{param_DM}}
 +
{{param_user}}|
 +
useAge=
 +
* 如果提供的私信ID不存在,则返回400错误,提示40010:Error: Direct Message does not exist!
 +
* 如果提供的私信ID不属于当前登录用户,返回400错误,提示:40021:Error: not your own direct message!|
 +
otherInfo=
 +
===Java示例===
 +
请从 [[SDK | 微博SDK开发包下载]] 下载Java SDK<br>
 +
代码示例如下:
 +
package weibo4j.examples;
 
   
 
   
===Formats:===
+
import java.util.List;
xml, json
+
 
   
 
   
=== HTTP Method(s): ===
+
import weibo4j.DirectMessage;
POST, DELETE
+
import weibo4j.Weibo;
 +
import weibo4j.WeiboException;
 
   
 
   
===Requires Authentication (about authentication):===
+
/**
true
+
* @author hezhou
   
+
  *
===API rate limited (about rate limiting):===
+
*/
false
+
  public class DestroyDirectMessage {
   
+
/**
===Parameters:===
+
* 删除一条私信
* id.  Required.  The ID of the direct message to destroy. 
+
* @param args
o Example: http://api.t.sina.com.cn/direct_messages/destroy/12345.json or http://twitter.com/direct_messages/destroy/23456.xml
+
*/
 
+
public static void main(String[] args) {
===Response (about return values): ===
+
System.setProperty("weibo4j.oauth.consumerKey", Weibo.CONSUMER_KEY);
XML example (truncated):
+
    System.setProperty("weibo4j.oauth.consumerSecret", Weibo.CONSUMER_SECRET);
<?xml version="1.0" encoding="UTF-8"?>
+
try {
<direct_message>
+
Weibo weibo = getWeibo(true,args);
<id>88619848</id>
+
weibo.destroyDirectMessage(Integer.parseInt(args[2]));
<sender_id>1401881</sender_id>
+
List<DirectMessage> list = weibo.getDirectMessages();
<text>all your bases are belong to us.</text>
+
for(DirectMessage msg : list) {
<recipient_id>7004322</recipient_id>
+
System.out.println(msg.toString());
<created_at>Wed Apr 08 20:30:04 +0000 2009</created_at>
+
}
<sender_screen_name>dougw</sender_screen_name>
+
} catch (WeiboException e) {
<recipient_screen_name>igudo</recipient_screen_name>
+
e.printStackTrace();
<sender>
+
}
<id>1401881</id>
+
}
<name>Doug Williams</name>
+
<screen_name>dougw</screen_name>
+
private static Weibo getWeibo(boolean isOauth,String[] args) {
<location>San Francisco, CA</location>
+
Weibo weibo = new Weibo();
<description>Twitter API Support. Internet, greed, users, dougw and opportunities are my passions.</description>
+
if(isOauth) {//oauth验证方式 args[0]:访问的token;args[1]:访问的密匙
<profile_image_url>http://s3.amazonaws.com/twitter_production/profile_images/59648642/avatar_normal.png</profile_image_url>
+
weibo.setToken(args[0], args[1]);
<url>http://www.igudo.com</url>
+
}else {//用户登录方式
<protected>false</protected>
+
    weibo.setUserId(args[0]);//用户名/ID
<followers_count>1036</followers_count>
+
    weibo.setPassword(args[1]);//密码
<profile_background_color>9ae4e8</profile_background_color>
+
}
<profile_text_color>000000</profile_text_color>
+
return weibo;
<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>
+
===PHP示例===
<friends_count>290</friends_count>
+
请从 [[SDK | 微博SDK开发包下载]] 处下载PHP SDK(支持OAuth验证之版本)<br>  
<created_at>Sun Mar 18 06:42:26 +0000 2007</created_at>
+
代码示例如下:
<favourites_count>0</favourites_count>
+
<pre>
<utc_offset>-18000</utc_offset>
+
//Direct messages/destroy
<time_zone>Eastern Time (US & Canada)</time_zone>
+
//删除一条私信
<profile_background_image_url>http://s3.amazonaws.com/twitter_production/profile_background_images/2752608/twitter_bg_grass.jpg</profile_background_image_url>
+
$c = new WeiboClient( WB_AKEY ,
<profile_background_tile>false</profile_background_tile>
+
                      WB_SKEY ,
<statuses_count>3394</statuses_count>
+
                      $_SESSION['last_key']['oauth_token'] ,
<notifications>false</notifications>
+
                      $_SESSION['last_key']['oauth_token_secret'] );
  <following>false</following>
+
//要删除的私信主键ID
<verified>true</verified>
+
$did = "Direct_Message_ID";
</sender>
+
$msg = $c->delete_dm( $did );
<recipient>
+
if ($msg === false || $msg === null){
<id>7004322</id>
+
echo "Error occured";
<name>Doug Williams</name>
+
return false;
<screen_name>igudo</screen_name>
+
}
<location>North Carolina</location>
+
if (isset($msg['error_code']) && isset($msg['error'])){
<description>A character.</description>
+
echo ('Error_code: '.$msg['error_code'].';  Error: '.$msg['error'] );
<profile_image_url>http://s3.amazonaws.com/twitter_production/profile_images/15446222/twitter_48_48_normal.jpg</profile_image_url>
+
return false;
<url>http://www.igudo.com</url>
+
}
<protected>false</protected>
+
echo('Deleted Message Info '.$msg['id'].' : '.$msg['text']);
<followers_count>19</followers_count>
+
</pre>
  <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>
+
 
+
===Usage examples: ===
+
cURL (about cURL):
+
 
+
curl -u user:password --http-request DELETE http://api.t.sina.com.cn/direct_messages/destroy/88619848.xml
+

2010年12月6日 (一) 11:53的最后版本

目录

direct_messages/destroy/:id

根据ID删除登录用户收到的私信。

URL

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

支持格式

XML/JSON

HTTP请求方式

POST/DELETE

是否需要登录

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

请求数限制

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

请求参数

  必选 类型及范围 说明
source true string 申请应用时分配的AppKey,调用接口时候代表应用的唯一身份。(采用OAuth授权方式不需要此参数)
:id true int64 要删除的私信ID。

注意事项

  • 如果提供的私信ID不存在,则返回400错误,提示40010:Error: Direct Message does not exist!
  • 如果提供的私信ID不属于当前登录用户,返回400错误,提示:40021:Error: not your own direct message!

返回结果

XML示例

<?xml version="1.0" encoding="UTF-8"?>
<direct_message>
  <created_at>Mon Dec 06 11:35:37 +0800 2010</created_at>
  <id>722778763</id>
  <text>qwe</text>
  <sender_id>1854740027</sender_id>
  <recipient_id>1854835127</recipient_id>
  <sender_screen_name>siegetest</sender_screen_name>
  <recipient_screen_name>siegetest2</recipient_screen_name>
  <sender>
    <id>1854740027</id>
    <screen_name>siegetest</screen_name>
    <name>siegetest</name>
    <province>11</province>
    <city>8</city>
    <location>北京 海淀区</location>
    <description>ABCDE</description>
    <url/>
    <profile_image_url>http://tp4.sinaimg.cn/1854740027/50/1291272213/1</profile_image_url>
    <domain/>
    <gender>m</gender>
    <followers_count>2</followers_count>
    <friends_count>20</friends_count>
    <statuses_count>18</statuses_count>
    <favourites_count>0</favourites_count>
    <created_at>Thu Nov 11 00:00:00 +0800 2010</created_at>
    <following>false</following>
    <verified>false</verified>
    <allow_all_act_msg>false</allow_all_act_msg>
    <geo_enabled>true</geo_enabled>
  </sender>
  <recipient>
    <id>1854835127</id>
    <screen_name>siegetest2</screen_name>
    <name>siegetest2</name>
    <province>11</province>
    <city>8</city>
    <location>北京 海淀区</location>
    <description/>
    <url/>
    <profile_image_url>http://tp4.sinaimg.cn/1854835127/50/0/1</profile_image_url>
    <domain/>
    <gender>m</gender>
    <followers_count>0</followers_count>
    <friends_count>20</friends_count>
    <statuses_count>2</statuses_count>
    <favourites_count>0</favourites_count>
    <created_at>Thu Nov 11 00:00:00 +0800 2010</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>

JSON示例

{
    "sender_screen_name" : "zhangwei217245",
    "recipient_screen_name" : "微博开放平台",
    "text" : "Wow~~~Congratulations!",
    "recipient" : 
    {
        "name" : "微博开放平台",
        "domain" : "openapi",
        "geo_enabled" : true,
        "followers_count" : 13366,
        "statuses_count" : 158,
        "favourites_count" : 0,
        "city" : "8",
        "description" : "新浪微博开放平台市场推广官方账号,如有技术问题,请@微博API或者发私信给微博API",
        "verified" : true,
        "status" : 
        {
            "created_at" : "Mon Nov 29 16:08:43 +0800 2010",
            "text" : "各位开发者,我们的论坛上线啦~http://sinaurl.cn/h4FWc7 欢迎大家的参与~另外,关于技术相关的问题,可以在论坛上提出,也可以@微博API 这个官方技术支持账号哦~感谢大家对开放平台的支持~[呵呵]",
            "truncated" : false,
            "in_reply_to_status_id" : "",
            "in_reply_to_screen_name" : "",
            "geo" : null,
            "favorited" : false,
            "in_reply_to_user_id" : "",
            "id" : 3958728723,
            "source" : "<a href=\"http://t.sina.com.cn\" rel=\"nofollow\">新浪微博</a>"
        },
        "id" : 11051,
        "gender" : "m",
        "friends_count" : 5,
        "screen_name" : "微博开放平台",
        "allow_all_act_msg" : true,
        "following" : false,
        "url" : "http://open.t.sina.com.cn/",
        "profile_image_url" : "http://tp4.sinaimg.cn/11051/50/1280283165/1",
        "created_at" : "Wed Jan 20 00:00:00 +0800 2010",
        "province" : "11",
        "location" : "北京 海淀区"
    },
    "sender" : 
    {
        "name" : "zhangwei217245",
        "domain" : "zhangwei217245",
        "geo_enabled" : true,
        "followers_count" : 24,
        "statuses_count" : 118,
        "favourites_count" : 3,
        "city" : "5",
        "description" : "ABCDE",
        "verified" : false,
        "status" : 
        {
            "created_at" : "Sat Dec 04 23:35:20 +0800 2010",
            "text" : "动物丛书的由来。。。http://sinaurl.cn/hbVjvr",
            "truncated" : false,
            "in_reply_to_status_id" : "",
            "annotations" : 
            [

            ],
            "in_reply_to_screen_name" : "",
            "geo" : null,
            "favorited" : false,
            "in_reply_to_user_id" : "",
            "id" : 4087921127,
            "source" : "<a href=\"http://t.sina.com.cn\" rel=\"nofollow\">新浪微博</a>"
        },
        "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_id" : 1658122963,
    "recipient_id" : 11051,
    "id" : 722715041,
    "created_at" : "Mon Dec 06 11:21:31 +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 java.util.List;

import weibo4j.DirectMessage;
import weibo4j.Weibo;
import weibo4j.WeiboException;

/**
* @author hezhou
*
*/
public class DestroyDirectMessage {
	/**
	 * 删除一条私信
	 * @param args
	 */
	public static void main(String[] args) {
		System.setProperty("weibo4j.oauth.consumerKey", Weibo.CONSUMER_KEY);
   	System.setProperty("weibo4j.oauth.consumerSecret", Weibo.CONSUMER_SECRET);
		try {
			Weibo weibo = getWeibo(true,args);
			weibo.destroyDirectMessage(Integer.parseInt(args[2]));
			List<DirectMessage> list = weibo.getDirectMessages();
			for(DirectMessage msg : list) {
				System.out.println(msg.toString());
			}
		} catch (WeiboException e) {
			e.printStackTrace();
		}
	}
	
	private static Weibo getWeibo(boolean isOauth,String[] args) {
		Weibo weibo = new Weibo();
		if(isOauth) {//oauth验证方式 args[0]:访问的token;args[1]:访问的密匙
			weibo.setToken(args[0], args[1]);
		}else {//用户登录方式
   		weibo.setUserId(args[0]);//用户名/ID
   		weibo.setPassword(args[1]);//密码
		}
		return weibo;
	}
}

PHP示例

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

//Direct messages/destroy
//删除一条私信
$c = new WeiboClient( WB_AKEY , 
                      WB_SKEY , 
                      $_SESSION['last_key']['oauth_token'] , 
                      $_SESSION['last_key']['oauth_token_secret']  );
//要删除的私信主键ID
$did = "Direct_Message_ID";
$msg = $c->delete_dm( $did );
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;
}
echo('Deleted Message Info '.$msg['id'].' : '.$msg['text']);
文档更新时间: 2010-12-06