|
|
| 第1行： |
第1行： |
| − | <h3>目录</h3>
| |
| − |
| |
| − | **[[#消息服务是什么|1 消息服务是什么]]
| |
| − | **[[#自定义回复|2 自定义回复]]
| |
| − | ***[[#自定义回复 - 示例|2.1 自定义回复 - 示例]]
| |
| − | ***[[#自定义回复实现步骤|2.2 自定义回复实现步骤]]
| |
| − | **[[#好友邀请|3 好友邀请]]
| |
| − | ***[[#好友邀请 - 示例|3.1 好友邀请 - 示例]]
| |
| − | ***[[#好友邀请实现步骤|3.2 好友邀请实现步骤]]
| |
| − |
| |
| − |
| |
| − |
| |
| − |
| |
| − | =消息服务是什么=
| |
| − | *消费服务是微博为应用、蓝V提供的与微博用户、粉丝进行消息交互的服务。
| |
| − | *通过此服务，应用、蓝V可在自己的产品中实现'''私信人工客服'''、'''私信自动回复'''、'''好友邀请'''等功能。
| |
| − |
| |
| − |
| |
| − | <h3>涵盖的主要功能模块：</h3>
| |
| − | <div style="text-align:center;">
| |
| − | <img src="http://ww1.sinaimg.cn/large/946308c5jw1e81panhb9yj20g605iglw.jpg" alt="946308c5jw1e823zq5uf5j218a0hwtfe.jpg" style="width: 260px;">
| |
| − | </div>
| |
| − |
| |
| − |
| |
| − | =自定义回复=
| |
| − | *使用消息服务自定义回复功能，蓝V 可以在自身的服务器或指定应用上接收微博用户与自己相关的行为消息，并可在72小时内按需进行文字、图文等私信的回复。
| |
| − |
| |
| − |
| |
| − | <h3>1、蓝V可接收的用户行为消息类型：</h3>
| |
| − | <img src="http://ww3.sinaimg.cn/large/946308c5jw1e823zq5uf5j218a0hwtfe.jpg" style="width: 680px;">
| |
| − |
| |
| − |
| |
| − | <h3>2、蓝V可回复的私信类型：</h3>
| |
| − | <img src="http://ww4.sinaimg.cn/large/946308c5jw1e82965yjsgj218g0hstej.jpg" style="width: 680px;">
| |
| − |
| |
| − | *回复规则：每条接收到的私信72小时内可回复3次,关注事件等非私信消息72小时内可回复1次。
| |
| − |
| |
| − |
| |
| − | ==自定义回复 - 示例==
| |
| − |
| |
| − |
| |
| − | <h3>1、应用于自动回复场景示例：</h3>
| |
| − | <img src="http://ww1.sinaimg.cn/large/946308c5jw1e82bqnof51j218g0p0aht.jpg" style="width: 680px;">
| |
| − |
| |
| − |
| |
| − |
| |
| − |
| |
| − | <h3>2、应用于人工客服场景示例: </h3>
| |
| − | <img src="http://ww3.sinaimg.cn/large/946308c5jw1e82bz60h0bj218i0p6afv.jpg" style="width: 680px;">
| |
| − |
| |
| − |
| |
| − |
| |
| − | ==自定义回复实现步骤==
| |
| − |
| |
| − | *1、蓝V用户开启自定义回复开发者模式
| |
| − | **蓝V用户在企业微博后台开启开发者模式，设置成将自己的私信、留言等新消息托管给指定应用处理。
| |
| − | **<font style="color:red">服务未正式开放，提前体验请邮件[mailto:shenbin1@staff.sina.com.cn shenbin1@staff.sina.com.cn]申请，需提供您希望实现的功能或服务场景，我们评估后确定是否提前为您开通。</font>
| |
| − |
| |
| − |
| |
| − | *2、蓝V通过应用连接消息服务接收微博用户与该蓝V相关的行为消息
| |
| − | **应用调用[[2/messages/receive|messages/receive]]接口与消息服务建立长连接，接收指定蓝V用户被关注、被取消关注、私信、留言等新消息。
| |
| − |
| |
| − |
| |
| − | *3、蓝V通过应用回复接收到的新消息
| |
| − | **应用对新消息进行相应的处理，调用[[2/messages/reply|messages/reply]]接口进行回复，实现关键词自动回复或交由蓝V客服进行72小时人工应答，所有回复以微博私信方式到达用户。
| |
| − |
| |
| − |
| |
| − |
| |
| − | =好友邀请=
| |
| − | *使用消息服务好友邀请功能，应用可以在自身的客户端上激励用户邀请自己微博好友加入应用，邀请将以Card形式私信好友。
| |
| − |
| |
| − |
| |
| − | *好友邀请规则:
| |
| − | **1，必须由用户主动发起；
| |
| − | **2，每用户每小时通过每应用可邀请10个互粉好友。
| |
| − |
| |
| − | ==好友邀请 - 示例==
| |
| − |
| |
| − |
| |
| − | <h3>应用于游戏邀请场景示例：</h3>
| |
| − | <img src="http://ww1.sinaimg.cn/large/946308c5jw1e82dbhnagqj218a0hajyk.jpg" style="width: 680px;">
| |
| − |
| |
| − |
| |
| − |
| |
| − | ==好友邀请实现步骤==
| |
| − |
| |
| − | *1、应用引导用户使用微博登录
| |
| − | **应用引导用户使用微博登录，采用[[授权机制说明|OAuth2]]的[[scope|Scope]]授权方式获得用户“发送私信邀请给你的微博好友”权限。
| |
| − |
| |
| − |
| |
| − | *2、应用获取用户微博互粉好友列表
| |
| − | **应用调用[[2/friendships/friends/bilateral|friendships/friends/bilateral]]接口，获取当前用户微博互粉好友列表，友好地引导、鼓励用户邀请好友加入应用或向好友送礼物等。
| |
| − |
| |
| − |
| |
| − | *3、应用获得用户确认后向指定用户发送邀请
| |
| − | **应用引导用户后由用户主动向好友发送邀请，应用调用[[2/messages/invite|messages/invite]]接口实现向指定好友发送邀请。
| |
| − |
| |
| − |
| |
| − | =消息推送接口=
| |
| − | 功能：
| |
| − | 消息推送接口，长连接微博推送服务，接收推送给指定蓝V用户的新消息。当有微博用户给蓝V发送新消息时，推送服务将此新消息格式化后由此长连接推送给该应用。
| |
| − |
| |
| − |
| |
| − | 接口调用地址：https://m.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。保存断开后5分钟内的新消息，可以通过since_id获取断开五分钟内的新消息。
| |
| − | |}
| |
| − |
| |
| − | 注意事项
| |
| − | *1、为确保应用及V用户信息安全，此接口必须在服务器端调用；
| |
| − | *2、调用接口的登录帐号为该appkey的所有者，需要使用所有者帐号通过Base Auth的方式；
| |
| − | *3、如appkey已绑定IP地址，调用接口的请求IP须为绑定的IP；
| |
| − | *4、指定的uid用户为蓝V；
| |
| − | *5、指定的uid用户已设置成将自己的微博私信、留言等消息箱服务交给当前应用托管;
| |
| − | *6、指定的uid用户已开启推送服务（当前托管即自动开启）;
| |
| − | *6、每条完整的新消息数据以json形式返回，默认采用UTF-8编码，且以\r\n分隔；
| |
| − | *7、新消息来源用户为蓝V且已开启消息服务时，新消息不推送；
| |
| − | *8、为缓解服务压力，请求建立后约每5分钟自动断开，应用需兼容根据最后一次获取的新消息ID重新调此接口连接；
| |
| − |
| |
| − |
| |
| − | 调用举例：
| |
| − | <pre>
| |
| − | curl -u "USERNAME:PASSWORD" "https://m.api.weibo.com/2/messages/receive.json?source=YOUR_APPKEY&uid=***"
| |
| − | </pre>
| |
| − |
| |
| − |
| |
| − | 连接建立后，当蓝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时为“取消关注事件消息”。
| |
| − | |-
| |
| − | |data
| |
| − | |string
| |
| − | |消息内容
| |
| − | |-
| |
| − | |data:subtype
| |
| − | |string
| |
| − | |follow：关注事件，unfollow取消关注事件。
| |
| − | |-
| |
| − | |data:key
| |
| − | |string
| |
| − | |subtype为follow或unfollow时不返回
| |
| − | |}
| |
| − |
| |
| − |
| |
| − | *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
| |
| − | |text
| |
| − | |-
| |
| − | |recipient_id
| |
| − | |int64
| |
| − | |消息的接收者
| |
| − | |-
| |
| − | |sender_id
| |
| − | |int64
| |
| − | |消息的发送者
| |
| − | |-
| |
| − | |created_at
| |
| − | |string
| |
| − | |消息创建时间
| |
| − | |-
| |
| − | |text
| |
| − | |string
| |
| − | |私信内容
| |
| − | |-
| |
| − | |data
| |
| − | |string
| |
| − | |消息内容，纯文本私信或留言为空
| |
| − | |}
| |
| − |
| |
| − | 注意：需要对接收到的消息体type活subtype做兼容，当出现未知时可忽略此消息。
| |
| − |
| |
| − |
| |
| − | 接口调用失败返回：
| |
| − | <pre>
| |
| − | {
| |
| − | "request": "/2/messages/receive.json",
| |
| − | "error_code": "264XX",
| |
| − | "error": "error message."
| |
| − | }
| |
| − | </pre>
| |
| − |
| |
| − |
| |
| | =消息回复接口= | | =消息回复接口= |
| | 功能： | | 功能： |
