跳到主要内容

设置用户订阅关系

融云允许您订阅用户在线状态,您不仅可以通过客户端来订阅在线状态,也可以通过服务端来设置订阅关系。

开通服务

您可以通过控制台开通服务。在融云控制台,选择 IM 服务 -> IM 服务管理 -> 客户端用户在线状态订阅,开启服务。

开通客户端用户在线状态订阅

请求方法

POST: https://数据中心域名/user/subscribe/set.json

签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名

频率限制: 每秒钟限 100 次

正文参数

HTTP 请求正文数据格式为 application/x-www-form-urlencoded,支持以下 HTTP 表单参数:

参数类型必传说明
subTypeint默认为 1,表示状态订阅
userIdString订阅者 ID
subUserIdsString被订阅用户的 ID,最多可以一次性订阅 200 个用户,多个用户 ID 之间用逗号分割。
opTypeint操作类型,0 表示添加订阅,1 表示取消订阅。
expirylong订阅有效期,操作类型为 0 必填。单位为秒。

请求示例

POST /user/subscribe/set.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX(最大长度36)

userId=uid1&subUserIds=s_user1,s_user2&opType=0&expiry=60&subType=1

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象:

返回值返回类型说明
codeInt返回码,200 为处理成功。
subUserIdsstring[]返回码 26021,仅返回被订阅用户达到限制的列表。

错误码

codehttpStatus说明
200200成功
26001400错误请求参数,参数不符合要求
26003500内部错误
26022403订阅用户超限
26021200被订阅用户达到上限
26020401未开启订阅功能

返回结果示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX

{"code":200}