高级群发接口

跳转到: 导航, 搜索
第1行: 第1行:
 
=高级群发接口=
 
=高级群发接口=
功能:
 
私信订阅群发接口,V用户可通过此接口给自己的订阅用户群发私信
 
  
  
接口调用地址:https://m.api.weibo.com/2/messages/sendall.json
+
=根据分组进行群发=
  
 +
接口调用请求说明:
  
HTTP请求方式:POST
+
<pre>
 +
URL:https://m.api.weibo.com/2/messages/sendall?access_token=ACCESS_TOKEN
  
 +
HTTP 请求方式:POST
  
是否需要登陆:是
+
授权限制:频次限制是
 +
</pre>
  
 +
POST数据说明:
 +
'''文本'''
 +
<pre>
 +
{
 +
  "filter":{
 +
      "group_id":"123"      //分组id
 +
  },
 +
  "text":{
 +
      "content":"CONTENT"  //文本内容
 +
  },
 +
    "msgtype":"text"
 +
}
 +
</pre>
  
频次限制:是
+
'''文本'''
 
+
<pre>
 
+
{
<div class="wiki_kit">
+
  "filter":{
 +
      "group_id":"123"      //分组id
 +
  },
 +
  "text":{
 +
      "content":"CONTENT"  //文本内容
 +
  },
 +
    "msgtype":"text"
 +
}
 +
</pre>
  
{|width="100%" border="0" cellspacing="0" cellpadding="0" class="wiki_table"
+
'''语音'''
<html><colgroup><col class="tbF1"/><col class="tbF2" /><col /></colgroup></html>
+
!colspan="4" scope="col" |<span id="接口请求参数">接口请求参数</span>
+
|-
+
|style="text-align:center; width: 12%"|参数名称
+
|style="text-align:center;width: 12%"|值的类型
+
|style="text-align:center;width: 11%"|是否必填
+
|style="text-align:center;"|说明描述
+
|-
+
|access_token
+
|string
+
|true
+
|在粉丝服务平台 - 高级功能 - 开发者模式页面中获取,或者OAuth2.0授权后获得, 详细参考 [[Messages_api/access_token|获取粉丝服务平台开发接口的access token]]
+
|-
+
|sender_id
+
|int64
+
|false
+
|消息发送方的用户ID,默认不填为当前登录用户ID。
+
|-
+
|range_type
+
|int
+
|true
+
|群发的范围,0:发送给指定的receiver_ids订阅用户;1:发送给所有订阅用户。默认为0。
+
|-
+
|receiver_ids
+
|string
+
|false
+
|群发的订阅用户ID,多个时使用英文半角逗号符分隔,最多不超过10000个。仅当range_type参数为0时有效且必填。
+
|-
+
|type
+
|string
+
|true
+
|需要以何种消息类型发送。text:纯文本,articles:图文
+
|-
+
|data
+
|string
+
|true
+
|消息数据,具体内容严格遵循type类型对应格式。必须为json做URLEncode后的字符串格式,采用UTF-8编码。
+
|}
+
 
+
==注意事项==
+
*1,当指定的sender_id不是当前登录用户时:
+
**当前登录用户必须为当前应用的所有者;
+
*2,指定的sender_id用户已指定当前应用为其开发,且指定的sender_id用户已开启“[[粉丝服务开发模式指南|开发模式]]”;
+
*3,当指定sender_id认证用户为媒体类型时,发送失败;
+
*4,指定的接收者必须为sender_id用户的订阅用户:
+
**所有接收者都不是订阅用户则报错;
+
**部分接收者为订阅用户返回成功,仅向订阅用户发送,非订阅用户不发送;
+
*5,群发周期内,已接收过免费群发的订阅用户不再接收此免费群发:
+
**当指定sender_id用户为橙V、政府时,订阅用户每周只能接收到sender_id用户的一次免费群发;
+
**当指定sender_id用户不是媒体、不是橙V、不是政府时,订阅用户每月只能接收到sender_id用户的一次免费群发;
+
 
+
 
+
此接口不得用于推广或引导用户使用任何与新浪微博有直接竞争关系的公司的服务,否则将永久关停指定应用或V用户使用资格。
+
 
+
==当前支持发送的消息类型(type)中,data支持的参数==
+
<h3>1、纯文本类型私信消息:text</h3>
+
 
<pre>
 
<pre>
 
{
 
{
     "text": "纯文本回复"
+
  "filter":{
 +
      "group_id":"123"      //分组id
 +
  },
 +
  "voice":{
 +
      "media_id":"xxxxxxxxx"  //文本内容
 +
  },
 +
     "msgtype":"voice"
 
}
 
}
 
</pre>
 
</pre>
<div class="wiki_kit">
 
{|width="100%" border="0" cellspacing="0" cellpadding="0" class="wiki_table"
 
<html><colgroup><col class="tbF1"/><col class="tbF2" /><col /></colgroup></html>
 
!colspan="4" scope="col" |<span id="data支持的参数描述">data支持的参数描述</span>
 
|-
 
|style="text-align:center; width: 12%"|参数名称
 
|style="text-align:center;width: 12%"|值的类型
 
|style="text-align:center;width: 11%"|是否必填
 
|style="text-align:center;"|说明描述
 
|-
 
|text
 
|string
 
|true
 
|要回复的私信文本内容。文本大小必须小于300个汉字。
 
|}
 
举例:
 
  
当data对应json为{"text": "纯文本响应"} 时,则进行URLEncode后对应data参数值为:%7b%0a++++%22text%22%3a+%22%e7%ba%af%e6%96%87%e6%9c%ac%e5%93%8d%e5%ba%94%22%0a%7d
 
  
则对应的调用为:
+
'''图片'''
 
<pre>
 
<pre>
curl -u "USERNAME:PASSWORD" -d "source=YOUR_APPKEY&sender_id=******&receiver_id=******&type=text&data=%7b%0a++++%22text%22%3a+%22%e7%ba%af%e6%96%87%e6%9c%ac%e5%93%8d%e5%ba%94%22%0a%7d" "https://m.api.weibo.com/2/messages/send.json" -k
+
{
 +
  "filter":{
 +
      "group_id":"123"     //分组id
 +
  },
 +
  "image":{
 +
      "media_id":"xxxxxxxxx"  //文本内容
 +
  },
 +
    "msgtype":"image"
 +
}
 
</pre>
 
</pre>
  
 
+
'''图文消息'''
<h3>2、图文类型私信消息:articles</h3>
+
 
<pre>
 
<pre>
 
{
 
{
    "articles": [
+
  "filter":{
        {
+
      "group_id":"123"     //分组id
            "display_name": "两个故事",
+
  },
            "summary": "今天讲两个故事,分享给你。谁是公司?谁又是中国人?​",
+
  "image":{
            "image": "http://storage.mcp.weibo.cn/0JlIv.jpg",
+
      "media_id":"xxxxxxxxx"  //文本内容
            "url": "http://e.weibo.com/mediaprofile/article/detail?uid=1722052204&aid=983319"
+
  },
        },
+
    "msgtype":"artice"
        ... //最多支持8个图文,建议为1或3个
+
    ]
+
 
}
 
}
 
</pre>
 
</pre>
<div class="wiki_kit">
 
{|width="100%" border="0" cellspacing="0" cellpadding="0" class="wiki_table"
 
<html><colgroup><col class="tbF1"/><col class="tbF2" /><col /></colgroup></html>
 
!colspan="4" scope="col" |<span id="data参数支持的参数">data参数支持的参数</span>
 
|-
 
|style="text-align:center; width: 12%"|参数名称
 
|style="text-align:center;width: 12%"|值的类型
 
|style="text-align:center;width: 11%"|是否必填
 
|style="text-align:center;"|说明描述
 
|-
 
|articles:display_name
 
|string
 
|true
 
|图文的显示名称标题
 
|-
 
|articles:summary
 
|string
 
|true
 
|图文的文字描述
 
|-
 
|articles:image
 
|string
 
|false
 
|图文的缩略显示图片
 
|-
 
|articles:url
 
|string
 
|true
 
|图文的URL地址,点击后跳转
 
|}
 
 
  
==返回结果==
+
'''图文素材'''
 
<pre>
 
<pre>
// 成功返回
 
 
{
 
{
    "result": true  //成功返回true,否则报错
+
  "filter":{
 +
      "group_id":"123"      //分组id
 +
  },
 +
  "news":{
 +
      "media_id":"xxxxxxxx"  //文本内容
 +
  },
 +
    "msgtype":"news"
 
}
 
}
 +
</pre>
  
// 失败返回
+
//返回说明
 
{
 
{
     "request": "/2/messages/post.json",
+
     "request": "XXXX/messages/custom_rule/create",
     "error_code": 264XX,
+
     "errcode": "1000XX",
     "error": "error message."
+
     "errmsg": "error message."
 
}
 
}
 
</pre>
 
</pre>
  
__NOTOC__
+
 
 +
=根据OpenID列表群发=
 +
 
 +
接口调用请求说明:
 +
 
 +
<pre>
 +
URL:https://m.api.weibo.com/2/messages/sendall?access_token=ACCESS_TOKEN
 +
 
 +
HTTP 请求方式:POST
 +
 
 +
授权限制:频次限制是
 +
</pre>
 +
 
 +
POST数据说明:
 +
 
 +
'''文本'''
 +
<pre>
 +
{
 +
    "touser":[
 +
    "uid1",
 +
    "uid2"
 +
  ],
 +
  "text":{
 +
      "content":"CONTENT"  //文本内容
 +
  },
 +
    "msgtype":"text"
 +
}
 +
</pre>
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
{| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color: #CCCCCC;"
 +
|-
 +
!width="15%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|参数
 +
!width="25%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|必选
 +
!width="25%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|类型及范围
 +
!width="35%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|说明
 +
{{api_args|uid|true|long|用户ID}}
 +
{{api_args|id|true|long|要删除的组ID}}
 +
|}

2014年5月15日 (四) 21:55的版本

高级群发接口

根据分组进行群发

接口调用请求说明:

URL:https://m.api.weibo.com/2/messages/sendall?access_token=ACCESS_TOKEN

HTTP 请求方式:POST

授权限制:频次限制是

POST数据说明: 文本

{
   "filter":{
      "group_id":"123"      //分组id
   },
   "text":{
      "content":"CONTENT"  //文本内容
   },
    "msgtype":"text"
}

文本

{
   "filter":{
      "group_id":"123"      //分组id
   },
   "text":{
      "content":"CONTENT"  //文本内容
   },
    "msgtype":"text"
}

语音

{
   "filter":{
      "group_id":"123"      //分组id
   },
   "voice":{
      "media_id":"xxxxxxxxx"  //文本内容
   },
    "msgtype":"voice"
}


图片

{
   "filter":{
      "group_id":"123"      //分组id
   },
   "image":{
      "media_id":"xxxxxxxxx"  //文本内容
   },
    "msgtype":"image"
}

图文消息

{
   "filter":{
      "group_id":"123"      //分组id
   },
   "image":{
      "media_id":"xxxxxxxxx"  //文本内容
   },
    "msgtype":"artice"
}

图文素材

{
   "filter":{
      "group_id":"123"      //分组id
   },
   "news":{
      "media_id":"xxxxxxxx"  //文本内容
   },
    "msgtype":"news"
}

//返回说明 {

   "request": "XXXX/messages/custom_rule/create",
   "errcode": "1000XX",
   "errmsg": "error message."

} </pre>


根据OpenID列表群发

接口调用请求说明:

URL:https://m.api.weibo.com/2/messages/sendall?access_token=ACCESS_TOKEN

HTTP 请求方式:POST

授权限制:频次限制是

POST数据说明:

文本

{
    "touser":[
    "uid1",
    "uid2"
   ],
   "text":{
      "content":"CONTENT"  //文本内容
   },
    "msgtype":"text"
}









参数 必选 类型及范围 说明
uid true long 用户ID
id true long 要删除的组ID