查询用户订阅关系

您可以通过本接口，查询用户的订阅关系。

开通服务

您可以通过融云控制台 IM 服务的服务购买页面开通客户端用户在线状态订阅服务。

请求方法

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

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

频率限制： 每秒钟限 100 次

正文参数

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

参数	类型	必传	说明
subType	Int	否	默认 1 为状态订阅
userId	String	是	订阅者 ID
pageToken	String	否	分页标识，默认空即第一页，设置上一页返回的 pageToken。
pageSize	Int	否	默认 200，最大为 200，最小 50。

请求示例

HTTP

POST /user/subscribe/update.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

返回结果

返回值	返回类型	说明
code	Int	返回码，200 为处理成功。
hasNext	boolean	是否有下一页
subscriptions	List<UserSubscriptionRecord>	订阅列表
pageToken	String	下一页 PageToken。

• UserSubscriptionRecord 结构说明：

  参数	返回类型	说明
  subUserIds	String[]	订阅用户
  subType	Int	订阅类型
  subTime	Long	订阅时间
  expiry	Long	订阅有效期

错误码

code	httpStatus	说明
200	200	成功
26001	400	错误请求参数，参数不符合要求
26003	500	内部错误
26022	403	订阅用户超限
26021	200	被订阅用户达到上限
26020	401	未开启订阅功能

返回结果示例

HTTP

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

{
    "code": 200,
    "hasNext": false,
    "pageToken": "1712909941322_2_3881222167",
    "subscriptions": [
        {
            "subUserIds": [
                "4",
                "5"
            ],
            "subType": 1,
            "subTime": 1712909941322,
            "expiry": 1000000
        }
    ]
}