2017年2月24日 (五) 16:17的版本

概述

微博与接入微博的第三方合作的一种模式是“服务端同步”，即微博直播互动系统和第三方互动系统之间做消息同步，从而实现消息共享的效果。发送消息接口和拉取消息接口（主动拉取和回调拉取）提供第三方的消息同步到微博的功能。

互动上行

说明

直播用户上行评论接口

URL

https://api.weibo.com/2/liveim/message/sync.json [POST]

支持格式

JSON

是否需要登录

true 登录授权方式，请参见本WIKI内的 如何登录授权

请求参数

返回结果

//成功返回

{
    "error_code":0，    // 0表示成功 其他表示失败。需要看错误消息
    "error_msg":""
}

//失败返回

{
    "error_code": 91XX,
    "error_msg": "xxxxxxxxx"
}

互动下行—Pull方式

说明

该接口提供第三方从微博直播互动系统拉取房间消息的功能。 第三方发起该请求之后，只要不断开连接，该接口会源源不断的推回房间中最新的消息。如果连接意外断开，只要重连之前累计消息数量不超过商定的阈值，消息都会从上次断开的地方继续推送。

URL

https://api.weibo.com/2/liveim/message/pull.stream [GET]

支持格式

JSON

是否需要登录

true 登录授权方式，请参见本WIKI内的如何登录授权

请求参数

返回结果 返回的消息以JSON的方式推送，推送的数据结构如下，每条消息是一个单独的JSON-OBJECT。

//成功返回

{
    "error_code":0，    // 0表示成功 其他表示失败。需要看错误消息
    "error_msg":"",
}
{
    // 消息体。见附件[数据结构/消息体]
}
{
    // 消息体
}
...

//失败返回

{
    "error_code": 91XX,
    "error_msg": "xxxxxxxxx"
}

关于错误返回值与错误代码，参见 错误码定义

互动下行—Callback方式

说明

如果第三方使用的是HTTP Callback的方式接受微博消息，那么第三方也需要提供一个类似[发送消息接口]的接口。要求与那个接口使用相同的参数和返回值。

URL

第三方自定义

支持格式

JSON

HTTP请求方式

POST

是否需要登录

true 登录授权方式，请参见本WIKI内的 如何登录授权

请求参数

返回结果

//成功返回

{
    "error_code":0，    // 0表示成功 其他表示失败。需要看错误消息
    "error_msg":""
}

//失败返回

{
    "error_code": 91XX,
    "error_msg": "xxxxxxxxx"
}

签名算法

输入：

- 键值对列表

- 签名时用的appsecret

输出：

签名结果字符串

算法：

- 键值对列表的每一项按照key=value的方式组成该项的字符串，各项的字符串按照对应key的字典序排序（key不相同），然后用半角"&"符号连接形成一个字符串。

- 字符串按照UTF-8编码得到一个字节序列input, secret的字符串按UTF-8编码生成一个字节序列作为key，用hmac-md5的方式计算哈希值的字节序列，哈希值字节序列使用URL-safe-Base64编码，取第6到16个字符作为结果输出。

算法示例：

假设输入是:
kv-pair: {"a":"1", "c":"jerry", "b":"tom"}
appsecret:  123456

连接成的字符串就是：
a=1&b=tom&c=jerry

hmac-md5("a=1&b=tom&c=jerry",123456)
输出得到字节数组：[-117, -27, -78, -5, 73, 68, -64, -50, 4, 21, 16, -55, -55, -39, -31, -15]

转成URL-safe的base64字符串：i-Wy-0lEwM4EFRDJydnh8Q==
取6到16位（初始位为0）子串，包含第6位，不包含第16位，共10位：lEwM4EFRDJ

签名结果：

lEwM4EFRDJ

数据结构

消息体

{
    "room_id":string,      // 房间号
    "room_sys_id": uint64, // 房间ID (内部)
    "msg_type":int,        // 消息类型，见“消息类型说明”
    "mid":long,
    "sender_info":{
        // 发送者的用户信息，见“用户信息”
    },
    "content":string,      // 消息内容
    "extension":string,    // 消息的扩展字段
    "offset": long,        // 消息距离视频开始时间间隔，单位ms
    "created_at":long      // 时间戳，距离1970-01-01 0:00:00 GMT的毫秒数
    // 如果还有其他字段，这些字段在此处继续，相关字段见“各消息类型的额外字段”
}

extension

消息类型1~14时，各类消息会有一些该类型特有的字段用于表示一些业务，这些字段会出现在extension中的sys字段里面，结构如下：

extension = {
    "sys": {
        // 此处出现的字段，见”各类型特有的额外字段“。如果额外字段列表为空，那么"sys"字段可以不存在。
    },
    // "其它透传的字段"
}

各类型特有的额外字段

聊天消息，msg_type=1
"msg_behavior":uint32  //消息的显示行为  0：默认 1.弹幕
 
点赞消息，msg_type=2
"praises_count":int    // 当前总赞数
"inc_praises":long     // 用户点赞次数
 
禁言，msg_type=4
"shut_info":{          // 被禁言的用户信息
    "shutted_until":uint32  //禁言结束的剩余时间,单位s
    "members":[              //被禁言用户列表
     {
       "uid":uint64          //被禁言用户的UID
       "user_system":string  //被禁言用户所属系统
     }
   ]
}
 
房间变更，msg_type=11
"live_status":int      // 表示直播的状态
"room_info": {
    // 房间信息体，见“房间信息”
}
 
加退房间，msg_type=12
"exit_or_enter_room":int  // 0:退出 1:进入
"room_info": {
    // 房间信息体，见“房间信息”
}
 
增加删除管理员，msg_type=14
"admin_info":{            // 被增加或删除的用户信息
    "uid":uint64              //管理员的UID
    "user_system":string      //管理员所属系统
    "type":int               //操作类型 1 增加 2 删除
}

直播接口

请参考直播接口文档

消息类型

   1 - 聊天消息
   2 - 赞消息
   3 - 点亮主播消息
   4 - 禁言消息
   6 - 公告消息
   7 - 分享直播消息
   8 - 关注主播消息
   11 - 直播变更消息（房间的任何状态变更都会进行push）
   12 - 加入/退出房间消息
   13 - 打赏消息
   14 - 管理员变更消息
   100 - 自定义消息类型

错误码定义