Receive Event Push

跳转到: 导航, 搜索

After users following or unfollowing to your weibo account,or @ your weibo account, the Weibo server will push this events to the url which the third Weibo account wrote in the fan service platform. It gives great convenience to developers to send users with welcome messages or unbundling account. For each POST request from Weibo, developer can respond it by return specific JSON in response body. Weibo Server will disconnect and request your callback url again if can't receive any response in 5 seconds. Weibo Server will retry 3 times in total. About eliminating the repetitive messages which may result from the retry mechanism, we recommend you eliminating the repetitive message by using sender_id plus created_at. If developer can't respond in 5 seconds, developer can reply with blank string. Weibo Server will not do anything with your blank string and will not retry after receiving your blank string.


目录

Following or Unfollowing event

Following or unfollowing event,push the JSON format is as follows:

{
    "type": "event",
    "receiver_id": 1902538057,
    "sender_id": 2489518277,
    "created_at": "Mon Jul 16 18:09:20 +0800 2012",
    "text": "关注事件消息",
    "data": {
        "subtype": "follow"
    }
}
Return Value
Parameters Type Description
type string event
receiver_id int64 Recipient of the message
sender_id int64 Sender of the message
created_at string Message creation time
text string The default copy。subtype is follow or unfollow:“Taking attention event”、“anceling attention event”;
data string Message Content
data:subtype string follow:Taking attention ,unfollow:canceling attention event

Subscribe or unsubscribe event

Subscribe or unsubscribe event,Push the JSON format is as follows:

{
    "type": "event",
    "receiver_id": 1902538057,
    "sender_id": 2489518277,
    "created_at": "Mon Jul 16 18:09:20 +0800 2012",
    "text": "订阅事件消息",
    "data": {
        "subtype": "subscribe"
    }
}
Return Value
Parameters Type Description
type string event
receiver_id int64 Recipient of the message
sender_id int64 Sender of the message
created_at string Message creation time
text string The default copy。为subscribe或unsubscribe时为触发订阅的私信关键词(如“dy”),非私信触发时(点击订阅按钮)为“订阅事件消息”、“取消订阅事件消息”;
data string Message Content
data:subtype string subscribe:Subscribe event,unsubscribe:Unsubscribe event。

Scanning a two-dimension code with parameters

Two-dimensional code scanning parameters event,push the JSON format is as follows:

{
    "type": "event",
    "receiver_id": 1902538057,
    "sender_id": 2489518277,
    "created_at": "Mon Jul 16 18:09:20 +0800 2012",
    "text": "扫描二维码",
    "data": {
        "subtype": "scan_follow",
        "key": "action_name_scene_id",
        "ticket": "TICKET",
    }
}
Return Value
Parameters Type Description
type string event
receiver_id int64 Recipient of the message
sender_id int64 Sender of the message
created_at string Message creation time
text string The default copy.subtype as "two-dimensional code scanning" when scan or scan_follow;
data string Message Content
data:subtype string scan and scan_follow for the two-dimensional code scanning event。
data:key string Event KEY values​​, format action_name_scene_id, ie to action_name prefixed behind two-dimensional code for scene_id;
data:ticket string Ticket-dimensional codes, two-dimensional code can be used to exchange pictures。

Have been @ message

Explanation: The specified user must be granted certification to receive "is @ message" permission, this interface will return to "be @ message", apply to e-mail jingyi7@staff.weibo.com

{
    "type": "mention",
    "receiver_id": 1902538057,
    "sender_id": 2489518277,
    "created_at": "Mon Jul 16 18:09:20 +0800 2012",
    "text": "被@的微博或评论文本信息",
    "data": {
        "subtype": "MENTION_TYPE,
        "key": "MENTION_KEY"
    }
}

// The default return only trusted users @ @ For returns all users, authenticated users can access this link set:http://account.weibo.com/set/message
Return Value
Parameters Type Description
type string mention
receiver_id int64 Recipient of the message
sender_id int64 Sender of the message
created_at string Message creation time
text string Text message or comment microblogging is @
data string Message Content
data:subtype string status:@ Microblogging,comment:@ Comment
data:key string When subtype for status as a microblogging ID, ID when comment for review

Pushing event when click menu to get messages

Click menu event,push the JSON format is as follows::

{
    "type": "event",
    "receiver_id": 1902538057,
    "sender_id": 2489518277,
    "created_at": "Mon Jul 16 18:09:20 +0800 2012",
    "text": "自定义菜单点击事件消息",
    "data": {
        "subtype": "click",
        "key": "EVENT_KEY"
    }
}
Return Value
Parameters Type Description
type string event
receiver_id int64 Recipient of the message
sender_id int64 Sender of the message
created_at string Message creation time
text string The default copy,subtype when click "Custom menu click event message";
data string Message Content
data:subtype string click, Custom menu click event
data:key string value is clicked custom menus

Pushing event when click jump url

Pushing event when click jump url,push the JSON format is as follows:

{
    "type": "event",
    "receiver_id": 1902538057,
    "sender_id": 2489518277,
    "created_at": "Mon Jul 16 18:09:20 +0800 2012",
    "text": "自定义菜单跳转链接事件消息",
    "data": {
        "subtype": "view",
        "key": "url"
    }
}
Return Value
Parameters Type Description
type string event
receiver_id int64 Recipient of the message
sender_id int64 Sender of the message
created_at string Message creation time
text string The default copy,subtype when view is "custom menu hoplinks event messages";
data string Message Content
data:subtype string view, Custom menu hoplinks event messages
data:key string Url the button settings
文档更新时间: 2015-10-28