Weibo Platform Logo

微博开放平台

weibo

Messages

跳转到： 导航, 搜索
 
（未显示3个用户的71个中间版本）
第1行： 第1行：
−
<div style="text-align:center;"><h1>消息接口使用手册</h1></div>
 
  
 +
=粉丝服务平台=
 +
*粉丝服务平台是为认证帐号、应用提供的与微博用户进行消息互动的服务。
  
−
=消息接口简介=
 
−
*微博开放平台消息接口基于微博消息箱，为应用、媒体、企业、政府等蓝V提供与微博用户进行消息交互的能力。以实现通过微博消息箱为粉丝、客户提供服务。
 
  
 +
*粉丝服务平台两大功能模块：
 +
<div style="margin:5px auto;padding:5px 0;">
 +
<ul style="margin:0;padding:0;list-style:none;font-weight:bold;text-align:center;">
 +
<li style="margin:0 10px;padding:0 15px;border:1px solid #D5E0E8;background:#F5FAFC;float:left;width:150px;height:35px;line-height:35px;">粉丝服务平台开发模式</li>
 +
<li style="margin:0 10px;padding:0 15px;border:1px solid #D5E0E8;background:#F5FAFC;float:left;width:150px;height:35px;line-height:35px;">应用消息服务</li>
 +
</ul>
 +
<div style="clear:both;height:0px;font-size:0px;padding:0;margin:0;border:0;line-height:0px;overflow:hidden;"></div>
 +
</div>
  
−
*服务未正式开放，提前体验请邮件[mailto:shenbin1@staff.sina.com.cn shenbin1@staff.sina.com.cn]申请，需提供您应用功能或服务场景，我们评估后确定是否提前为您开通。
 
  
−
=消息接口使用步骤=
+
=粉丝服务平台开发模式=
 +
<ul>
 +
    <li style="float: left;width: 100px;"><img src="http://ww2.sinaimg.cn/large/946308c5jw1ea4cav8tyqj2036038jr8.jpg" style="width: 80px;"></li>
 +
    <li style="float: left;width: 520px;padding-top: 20px;">通过开放的消息接口，帮助微博认证帐号在自身服务中为主动订阅他的粉丝提供更精彩、更个性化的内容和更有趣的互动服务。</li>
 +
<div style="background-position: 0 -703px;font-size: 14px; line-height: 30px; padding: 0 16px;background-color: #EFF8FB;display: inline-block;color: #fff;">[[粉丝服务开发模式指南|指南文档]]</div>
 +
</ul>
 +
<div class="wiki_index">
 +
<div class="sub_tag" style="padding-bottom: 0px;">
 +
<ul class="clearfix">
 +
{{IndexModu2
 +
| icon=api
 +
| link=[[自定义回复|自定义回复]]
 +
| desc=认证帐号可在自身服务中根据接收的用户消息，在72小时内向用户回复文字、图文等私信内容，实现如：自动回复或人工客服的功能。}}
  
−
*1、蓝V用户开启新消息推送
+
{{IndexModu2
−
**蓝V用户授权指定应用处理其新消息，并开启新消息推送。
+
| icon=api
 +
| link=[[订阅发送|订阅发送]]
 +
| desc=认证帐号可在自身服务中向订阅用户群发私信。}}
  
 +
{{IndexModu2
 +
| icon=api
 +
| link=[[私信提醒|私信提醒]]
 +
| desc=认证帐号可在自身服务中根据用户设置的条件向用户发送私信提醒。 }}
 +
</ul>
 +
</div>
 +
</div>
  
−
*2、应用连接、推送开始
+
=应用消息服务=
−
**应用调用messages/receive接口进行长连接，接收指定蓝V用户的新消息，若蓝V已指定该应用且开启服务，则连接成功，当有微博用户给蓝V发送新消息时，推送服务将此新消息格式化后由此长连接推送给该应用。
+
<ul>
 +
    <li style="float: left;width: 100px;"><img src="http://ww2.sinaimg.cn/large/946308c5jw1ea4cav8tyqj2036038jr8.jpg" style="width: 80px;"></li>
 +
    <li style="float: left;width: 520px;padding-top: 20px;">通过开放的消息接口，为微博应用提供拉新，活跃，扩散的能力。 <br><br> </li>
 +
<div style="background-position: 0 -703px;font-size: 14px; line-height: 30px; padding: 0 16px;background-color: #EFF8FB;display: inline-block;color: #fff;">[[好友邀请|指南文档]]</div>
 +
</ul>
 +
<div class="wiki_index">
 +
<div class="sub_tag" style="padding-bottom: 0px;">
 +
<ul class="clearfix">
 +
{{IndexModu2
 +
| icon=api
 +
| link=[[好友邀请|好友邀请]]
 +
| desc=应用可以在自身的客户端上激励用户邀请自己互粉好友使用应用、送礼物。}}
 +
</ul>
 +
</div>
 +
</div>
  
 +
=粉丝服务平台示例=
 +
<img src="http://www.sinaimg.cn/blog/developer/wiki/messageshili2.png" style="width: 680px;">
  
−
*3、回复接收到的新消息
+
=联系方式=
−
**应用调用messages/reply接口对接收到的新消息进行处理，实现关键词自动回复或交由蓝 V 客服进行72小时人工应答，所有回复以微博私信方式到达用户。
+
使用过程中有任何疑问或建议，欢迎邮件 [mailto:open_api@sina.com open_api@sina.com] 。
−
 
+
−
=消息推送接口=
+
−
功能：
+
−
消息推送接口，长连接微博推送服务，接收推送给指定蓝V用户的新消息
+
−
 
+
−
 
+
−
接口调用地址：https://api.weibo.com/2/messages/receive.json
+
−
 
+
−
 
+
−
HTTP请求方式：GET
+
−
 
+
−
 
+
−
是否需要登陆：是
+
−
 
+
−
 
+
−
<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="接口请求参数">接口请求参数</span>
+
−
|-
+
−
|style="text-align:center; width: 12%"|参数名称
+
−
|style="text-align:center;width: 12%"|值得类型
+
−
|style="text-align:center;width: 11%"|是否必填
+
−
|style="text-align:center;"|说明描述
+
−
|-
+
−
|source
+
−
|string
+
−
|true
+
−
|申请应用时分配的AppKey，调用接口时候代表应用的唯一身份。
+
−
|-
+
−
|uid
+
−
|int64
+
−
|true
+
−
|需要接收的蓝V用户ID。
+
−
|-
+
−
|since_id
+
−
|int64
+
−
|false
+
−
|上次连接断开时的消息ID。保存断开后五分钟内的新消息，可以通过since_id获取断开五分钟内的新消息。
+
−
|}
+
−
 
+
−
注意事项
+
−
*1、调用接口的登录帐号为该appkey的创建者，需要使用创建者帐号通过Base Auth的方式；
+
−
*2、调用接口的请求IP为该appkey绑定的IP地址；
+
−
*3、指定的uid用户为蓝V；
+
−
*4、指定的uid用户已设置成将自己的新消息推送给该appkey;
+
−
*5、指定的uid用户已开启推送;
+
−
*6、每条完整的新消息数据以json形式返回，默认采用UTF-8编码，且以\r\n分隔；
+
−
*7、蓝V与蓝V之间产生的新消息不推送；
+
−
*8、为缓解服务压力，请求建立后十分钟自动断开，应用需兼容重新调此接口连接。
+
−
 
+
−
 
+
−
连接建立后，当蓝V有新消息时，微博消息服务通过此连接向应用推送新消息，当前支持的消息类型：
+
−
 
+
−
 
+
−
*1、事件消息：event
+
−
<pre>
+
−
{
+
−
    "id": 1211260020031346,
+
−
    "type": "event",
+
−
    "recipient_id": 1902538057,
+
−
    "sender_id": 2489518277,
+
−
    "created_at": "Mon Jul 16 18:09:20 +0800 2012",
+
−
    "text": "事件消息",
+
−
    "data": {
+
−
        "subtype": "EVENT",
+
−
        "key": "EVENT_KEY"
+
−
    }
+
−
}
+
−
</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="3" scope="col" |<span id="返回值说明">返回值说明</span>
+
−
|-
+
−
|style="text-align:center; width: 12%"|属性
+
−
|style="text-align:center;width: 12%"|值得类型
+
−
|style="text-align:center;"|说明描述
+
−
|-
+
−
|id
+
−
|string
+
−
|消息ID
+
−
|-
+
−
|type
+
−
|string
+
−
|event
+
−
|-
+
−
|recipient_id
+
−
|int64
+
−
|消息的接收者
+
−
|-
+
−
|sender_id
+
−
|int64
+
−
|消息的发送者
+
−
|-
+
−
|created_at
+
−
|string
+
−
|消息创建时间
+
−
|-
+
−
|text
+
−
|string
+
−
|默认文案。subtype为follow时为“关注事件消息”，为unfollow时为“取消关注事件”，为click时为“自定义菜单点击事件消息”
+
−
|-
+
−
|data
+
−
|string
+
−
|消息内容
+
−
|-
+
−
|data:subtype
+
−
|string
+
−
|follow：关注事件，unfollow：取消关注事件，click：私信会话界面自定义菜单点击事件
+
−
|-
+
−
|data:key
+
−
|string
+
−
|被点击的自定义菜单key值，非click事件返回空
+
−
|}
+
−
 
+
−
 
+
−
*2、纯文本类型私信消息：text
+
−
<pre>
+
−
{
+
−
    "id": 1211260020031346,
+
−
    "type": "text",
+
−
    "recipient_id": 1902538057,
+
−
    "sender_id": 2489518277,
+
−
    "created_at": "Mon Jul 16 18:09:20 +0800 2012",
+
−
    "text": "私信内容",
+
−
    "data": {}
+
−
}
+
−
</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="3" scope="col" |<span id="返回值说明">返回值说明</span>
+
−
|-
+
−
|style="text-align:center; width: 12%"|属性
+
−
|style="text-align:center;width: 12%"|值得类型
+
−
|style="text-align:center;"|说明描述
+
−
|-
+
−
|id
+
−
|string
+
−
|消息ID
+
−
|-
+
−
|type
+
−
|string
+
−
|follow
+
−
|-
+
−
|recipient_id
+
−
|int64
+
−
|消息的接收者
+
−
|-
+
−
|sender_id
+
−
|int64
+
−
|消息的发送者
+
−
|-
+
−
|created_at
+
−
|string
+
−
|消息创建时间
+
−
|-
+
−
|text
+
−
|string
+
−
|私信内容
+
−
|-
+
−
|data
+
−
|string
+
−
|消息内容，纯文本私信为空
+
−
|}
+
−
 
+
−
 
+
−
*3、位置类型私信消息：position
+
−
<pre>
+
−
{
+
−
    "id": 1211260020031347,
+
−
    "type": "position",
+
−
    "recipient_id": 1902538057,
+
−
    "sender_id": 2489518277,
+
−
    "created_at": "Mon Jul 16 18:09:20 +0800 2012",
+
−
    "text": "一个位置消息",
+
−
    "data": {
+
−
        "longitude": "344.3344",
+
−
        "latitude": "232.343434"
+
−
    }
+
−
}
+
−
</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="3" scope="col" |<span id="返回值说明">返回值说明</span>
+
−
|-
+
−
|style="text-align:center; width: 12%"|属性
+
−
|style="text-align:center;width: 12%"|值得类型
+
−
|style="text-align:center;"|说明描述
+
−
|-
+
−
|id
+
−
|string
+
−
|消息ID
+
−
|-
+
−
|type
+
−
|string
+
−
|position
+
−
|-
+
−
|recipient_id
+
−
|int64
+
−
|消息的接收者
+
−
|-
+
−
|sender_id
+
−
|int64
+
−
|消息的发送者
+
−
|-
+
−
|created_at
+
−
|string
+
−
|消息创建时间
+
−
|-
+
−
|text
+
−
|string
+
−
|默认文案
+
−
|-
+
−
|data
+
−
|string
+
−
|消息内容
+
−
|-
+
−
|data:longitude
+
−
|string
+
−
|经度
+
−
|-
+
−
|data:latitude
+
−
|string
+
−
|纬度
+
−
|}
+
−
 
+
−
注意：需要对接收到的消息体type做兼容，当出现未知type时可忽略此消息。
+
−
 
+
−
 
+
−
接口调用失败返回：
+
−
<pre>
+
−
{
+
−
    "request": "/2/messages/receive.json",
+
−
    "error_code": "203XX",
+
−
    "error": "error message."
+
−
}
+
−
</pre>
+
−
 
+
−
 
+
−
=消息回复接口=
+
−
功能：
+
−
消息响应接口，对接收到的指定新消息进行回复
+
−
 
+
−
 
+
−
接口调用地址：https://api.weibo.com/2/messages/reply.json
+
−
 
+
−
 
+
−
HTTP请求方式：POST
+
−
 
+
−
 
+
−
是否需要登陆：是
+
−
 
+
−
 
+
−
<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="接口请求参数">接口请求参数</span>
+
−
|-
+
−
|style="text-align:center; width: 12%"|参数名称
+
−
|style="text-align:center;width: 12%"|值得类型
+
−
|style="text-align:center;width: 11%"|是否必填
+
−
|style="text-align:center;"|说明描述
+
−
|-
+
−
|source
+
−
|string
+
−
|true
+
−
|申请应用时分配的AppKey，调用接口时候代表应用的唯一身份。
+
−
|-
+
−
|id
+
−
|int64
+
−
|true
+
−
|需要响应的推送消息ID。
+
−
|-
+
−
|type
+
−
|string
+
−
|true
+
−
|需要以何种类型的消息进行响应。text：纯文本。
+
−
|-
+
−
|data
+
−
|string
+
−
|true
+
−
|消息数据，具体内容严格遵循type类型对应格式。必须为json做URLEncode后的字符串格式，采用UTF-8编码。字符串长度不超过2512个字节。
+
−
|}
+
−
 
+
−
注意事项
+
−
*1、调用接口的登录帐号必须为该appkey的创建者，需要使用创建者帐号通过Base Auth的方式；
+
−
*2、指定ID的新消息创建时间在72小时内；
+
−
*3、指定ID的新消息只能回复一次，多次回复报错；
+
−
*4、指定ID的新消息对应的原接收者身份发出此消息;
+
−
*5、指定ID的新消息对应的原发送者将收到此消息;
+
−
*6、发送者未被屏蔽或拉黑时消息进私信箱。
+
−
 
+
−
 
+
−
当前支持回复的消息类型中，data参数支持的参数：
+
−
*1、纯文本类型私信消息：text
+
−
<pre>
+
−
{
+
−
    "text": "纯文本回复"
+
−
}
+
−
</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"。
+
−
 
+
−
 
+
−
*2、图文类型私信消息：articles
+
−
<pre>
+
−
{
+
−
    "articles": [
+
−
        {
+
−
            "display_name": "两个故事",
+
−
            "summary": "今天讲两个故事，分享给你。谁是公司？谁又是中国人？​",
+
−
            "image": "http://storage.mcp.weibo.cn/0JlIv.jpg",
+
−
            "url": "http://e.weibo.com/mediaprofile/article/detail?uid=1722052204&aid=983319"
+
−
        }
+
−
    ]
+
−
}
+
−
</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
+
−
|true
+
−
|图文的缩略显示图片
+
−
|-
+
−
|articles:url
+
−
|string
+
−
|true
+
−
|图文的URL地址，点击后跳转
+
−
|}
+
−
 
+
−
 
+
−
接口调用失败返回：
+
−
<pre>
+
−
{
+
−
    "request": "/2/messages/reply.json",
+
−
    "error_code": "203XX",
+
−
    "error": "error message."
+
−
}
+
−
</pre>
+
  
 
__NOTOC__
 
__NOTOC__

2014年4月15日 (二) 18:12的最后版本

粉丝服务平台

  • 粉丝服务平台是为认证帐号、应用提供的与微博用户进行消息互动的服务。


  • 粉丝服务平台两大功能模块：
  • 粉丝服务平台开发模式
  • 应用消息服务


粉丝服务平台开发模式

  • 通过开放的消息接口，帮助微博认证帐号在自身服务中为主动订阅他的粉丝提供更精彩、更个性化的内容和更有趣的互动服务。

  • 自定义回复

    认证帐号可在自身服务中根据接收的用户消息，在72小时内向用户回复文字、图文等私信内容，实现如：自动回复或人工客服的功能。

  • 订阅发送

    认证帐号可在自身服务中向订阅用户群发私信。

  • 私信提醒

    认证帐号可在自身服务中根据用户设置的条件向用户发送私信提醒。

应用消息服务

  • 通过开放的消息接口，为微博应用提供拉新，活跃，扩散的能力。

  • 好友邀请

    应用可以在自身的客户端上激励用户邀请自己互粉好友使用应用、送礼物。

粉丝服务平台示例

联系方式

使用过程中有任何疑问或建议，欢迎邮件 open_api@sina.com 。


来自“http://open.weibo.com/wiki/index.php?title=Messages&oldid=12712”
文档更新时间: 2014-04-15

关于微博开放平台| 联系我们| 服务条款| 无线游戏| 开放平台官微

京网文 [2011] 0398-130号 京ICP证100780号 Copyright © 1996-2024 SINA