Direct messages/destroy

跳转到: 导航, 搜索
 
(未显示1个用户的1个中间版本)
第1行: 第1行:
== 删除私信 ==
+
{{api_desc2|
按ID删除私信。操作用户必须为私信的接收人。
+
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,
xml, json
+
             "in_reply_to_user_id" : "",
+
             "id" : 4087921127,
=== HTTP请求方式===
+
             "source" : "<a href=\"http://t.sina.com.cn\" rel=\"nofollow\">新浪微博</a>"
POST, DELETE
+
        },
+
        "id" : 1658122963,
===是否需要身份验证===
+
        "gender" : "m",
true
+
        "friends_count" : 44,
+
        "screen_name" : "zhangwei217245",
===请求数限制===
+
        "allow_all_act_msg" : false,
true
+
        "following" : false,
+
        "url" : "",
===请求参数===
+
        "profile_image_url" : "http://tp4.sinaimg.cn/1658122963/50/1282754213",
* id. 必填参数,要删除的私信主键ID. 
+
        "created_at" : "Tue Nov 03 00:00:00 +0800 2009",
o 示例: http://api.t.sina.com.cn/direct_messages/destroy/12345.json
+
        "province" : "11",
 
+
        "location" : "北京 朝阳区"
===使用说明===
+
    },
* 参数错误,或者id不存在返回400错误
+
    "sender_id" : 1658122963,
 
+
    "recipient_id" : 11051,
===返回结果===
+
    "id" : 722715041,
XML示例:
+
    "created_at" : "Mon Dec 06 11:21:31 +0800 2010"
  <?xml version="1.0" encoding="UTF-8"?>
+
}
  <direct_message>
+
</pre>
    <created_at>Fri Jan 08 15:15:31 +0800 2010</created_at>
+
    <id>207675</id>
+
    <text>send dm 777</text>
+
    <sender_id>10506</sender_id>
+
    <recipient_id>11075</recipient_id>
+
    <sender_screen_name>name_10506</sender_screen_name>
+
    <recipient_screen_name>name_11075</recipient_screen_name>
+
    <sender>
+
      <id>10506</id>
+
      <screen_name>name_10506</screen_name>
+
      <name>name_10506</name>
+
      <province>0</province>
+
      <city>0</city>
+
      <location></location>
+
      <description></description>
+
      <url></url>
+
      <profile_image_url>http://tp3.sinaimg.cn/10506/50/0</profile_image_url>
+
      <domain>10506</domain>
+
      <gender></gender>
+
      <followers_count>24</followers_count>
+
      <friends_count>50</friends_count>
+
      <statuses_count>47</statuses_count>
+
      <favourites_count>0</favourites_count>
+
      <created_at>Thu Jan 01 08:00:00 +0800 1970</created_at>
+
      <following>false</following>
+
      <verified>false</verified>
+
      <geo_enabled>false</geo_enabled>
+
    </sender>
+
    <recipient>
+
      <id>11075</id>
+
      <screen_name>name_11075</screen_name>
+
      <name>name_11075</name>
+
      <province>0</province>
+
      <city>0</city>
+
      <location></location>
+
      <description></description>
+
      <url></url>
+
      <profile_image_url>http://tp4.sinaimg.cn/11075/50/0</profile_image_url>
+
      <domain>11075</domain>
+
      <gender></gender>
+
      <followers_count>28</followers_count>
+
      <friends_count>50</friends_count>
+
      <statuses_count>29</statuses_count>
+
      <favourites_count>0</favourites_count>
+
      <created_at>Thu Jan 01 08:00:00 +0800 1970</created_at>
+
      <following>false</following>
+
      <verified>true</verified>
+
      <geo_enabled>false</geo_enabled>
+
    </recipient>
+
  </direct_message>
+
 
+
JSON示例:
+
 
+
  {
+
    "created_at":"Wed Jan 06 11:48:24 +0800 2010",
+
    "id":207568,
+
    "text":"test",
+
    "sender_id":10506,
+
    "recipient_id":11075,
+
    "sender_screen_name":"name_10506",
+
    "recipient_screen_name":"name_11075",
+
    "sender":
+
          {"id":10506,
+
             "screen_name":"name_10506",
+
             "name":"name_10506",
+
             "province":null,
+
             "city":null,
+
             "location":"",
+
             "description":"",
+
             "url":"",
+
            "profile_image_url":"http://tp3.sinaimg.cn/10506/50/0",
+
            "domain":"10506",
+
            "followers_count":24,
+
            "friends_count":50,
+
            "statuses_count":0,
+
            "favourites_count":25,
+
            "created_at":"Thu Jan 01 08:00:00 +0800 1970",
+
            "following":false,
+
            "geo_enabled":false,
+
            "verified":false},
+
    "recipient":
+
          {"id":11075,
+
            "screen_name":"name_11075",
+
            "name":"name_11075",
+
            "province":null,
+
            "city":null,
+
            "location":"",
+
            "description":"",
+
            "url":"",
+
            "profile_image_url":"http://tp4.sinaimg.cn/11075/50/0",
+
            "domain":"11075",
+
            "followers_count":28,
+
            "friends_count":50,
+
            "statuses_count":0,
+
            "favourites_count":11,
+
            "created_at":"Thu Jan 01 08:00:00 +0800 1970",
+
            "following":false,
+
            "geo_enabled":false,
+
            "verified":true}
+
  }
+
 
{{param_DM}}
 
{{param_DM}}
{{param_user}}
+
{{param_user}}|
 
+
useAge=
===使用示例===
+
* 如果提供的私信ID不存在,则返回400错误,提示40010:Error: Direct Message does not exist!
 
+
* 如果提供的私信ID不属于当前登录用户,返回400错误,提示:40021:Error: not your own direct message!|
* xml
+
otherInfo=
curl -u user:password --http-request DELETE http://api.t.sina.com.cn/direct_messages/destroy/88619848.xml
+
===Java示例===
 
+
* json
+
 
+
curl -u user:password --http-request DELETE http://api.t.sina.com.cn/direct_messages/destroy/88619848.json
+
 
+
====Java示例====
+
 
请从 [[SDK | 微博SDK开发包下载]] 下载Java SDK<br>
 
请从 [[SDK | 微博SDK开发包下载]] 下载Java SDK<br>
 
代码示例如下:
 
代码示例如下:
第186行: 第207行:
 
  }
 
  }
 
  }
 
  }
====PHP示例====
+
===PHP示例===
 
请从 [[SDK | 微博SDK开发包下载]] 处下载PHP SDK(支持OAuth验证之版本)<br>  
 
请从 [[SDK | 微博SDK开发包下载]] 处下载PHP SDK(支持OAuth验证之版本)<br>  
 
代码示例如下:
 
代码示例如下:
第209行: 第230行:
 
echo('Deleted Message Info '.$msg['id'].' : '.$msg['text']);
 
echo('Deleted Message Info '.$msg['id'].' : '.$msg['text']);
 
</pre>
 
</pre>
 +
}}

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