Set User Subscription
RC allows you to subscribe to user online status. You can not only subscribe to online status through the client but also set subscription relationships through the server.
Enable the Service
You can enable the service through the Console. In the RC Console, navigate to Chat settings > Chat pricing plans -> Subscription User Status, and enable the service.
Request Method
POST: https://Data Center Domain/user/subscribe/set.json
Signature Rule: All server API requests must undergo rule verification. For details, see API Request Signature.
Rate Limit: 100 requests per second
Body Parameters
The HTTP request body data format is application/x-www-form-urlencoded, and supports the following HTTP form parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| subType | int | No | Default is 1, indicating status subscription. |
| userId | String | Yes | Subscriber ID |
| subUserIds | String | Yes | IDs of the users to be subscribed. You can subscribe to up to 200 users at once, with multiple user IDs separated by commas. |
| opType | int | Yes | Operation type. 0 indicates adding a subscription, 1 indicates canceling a subscription. |
| expiry | long | No | Subscription validity period, required when the operation type is 0. Unit: seconds. |
Request Example
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
Response
The HTTP response body contains a JSON object with the following structure:
| Return Value | Return Type | Description |
|---|---|---|
| code | Int | Return code. 200 indicates success. |
| subUserIds | string[] | Return code 26021, only returns the list of users that have reached the subscription limit. |
Error Codes
| code | httpStatus | Description |
|---|---|---|
| 200 | 200 | Success |
| 26001 | 400 | Invalid request parameters. |
| 26003 | 500 | Internal error |
| 26022 | 403 | Subscription user limit exceeded |
| 26021 | 200 | Subscribed user limit reached |
| 26020 | 401 | Subscription feature not enabled |
Response Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX
{"code":200}