Unfollow Users
Feature Description
Unfollow a user, support batch unfollowing.
API Call Description
Sample Request URL
https://xxxxxx/v4/follow/follow_delete?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request Parameters
The following table lists only the parameters involved in modification when calling this API and their descriptions. For more details about the parameters, refer to RESTful API Overview.
Parameter | Description |
xxxxxx | Dedicated domain name corresponding to the country/region where the SDKAppID is located: China: console.tim.qq.com Singapore: adminapisgp.im.qcloud.com Seoul: adminapikr.im.qcloud.com Frankfurt: adminapiger.im.qcloud.com Mumbai: adminapiind.im.qcloud.com Silicon Valley: adminapiusa.im.qcloud.com |
v4/follow/follow_delete | Request API. |
sdkappid | SDKAppID assigned by the Chat console when an app is created. |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format, which should always be json . |
Maximum Calling Frequency
200 times/second.
Sample Requests
{"From_Account":"UserID_001","To_Account":["UserID_002", "UserID_003"]}
Request Fields
Field | Type | Attribute | Description |
From_Account | String | Required | The UserID of the operating user who initiated the unfollow operation. |
To_Account | Array | Required | The UserID of the user to be unfollowed. The number of To_Accounts per request should not exceed 20. |
Sample response
{"ResultItem": [{"To_Account": "UserID_002","ResultCode": 0,"ResultInfo": ""},{"To_Account": "UserID_003","ResultCode": 0,"ResultInfo": ""}],"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "","ErrorDisplay": ""}
Response Fields
Field | Type | Description |
ResultItem | Array | Result object array of batch unfollowing |
To_Account | String | The UserID of the user who requested to unfollow. |
ResultCode | Integer | Processing result of To_Account: 0: Processing succeeded. Non-zero: Processing failed. |
ResultInfo | String | Error description information of To_Account, this field is empty when successful. |
ActionStatus | String | Request processing result: OK: Processing succeeded. FAIL: Processing failed. |
ErrorCode | Integer | Error Code: 0: Processing succeeded. Non-zero: Processing failed. |
ErrorInfo | String | Detailed error information. |
Error Codes
The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields
ErrorCode
and ErrorInfo
respectively.The following table describes the error codes specific to this API:
Error Code | Description |
30001 | Request parameter error. Please check the request parameters according to the error description. |
30002 | SDKAppID mismatch |
30003 | Requested user account does not exist |
30004 | request requires App administrator permissions |
30006 | Server internal error, please try again. |
30007 | Network timeout, please try again. |
Debugging Tool for API
References
Callback Triggering Scenarios