tencent cloud

Retrieve Fans, Follows, And Mutual Followers List
Download PDF
Last updated:2025-10-23 15:01:17
Retrieve Fans, Follows, And Mutual Followers List
Last updated: 2025-10-23 15:01:17
Download PDF

Feature Description

Paged pull of fans/follows/mutual followers list for designated users.
Notes:
Note: To use the follow feature, purchase Pro, Pro-plus, or Enterprise Edition, then enable it in Console > Configuration > Friends and Relationship Chains > Follow / Fan function settings page.

API Call Description

Sample Request URL

https://xxxxxx/v4/follow/follow_get?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request Parameters

The following table describes the modified parameters when this API is called. For other parameters, see 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
Tokyo：adminapijpn.im.qcloud.com
Frankfurt: adminapiger.im.qcloud.com
Mumbai: adminapiind.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
v4/follow/follow_get
Request API.
sdkappid
SDKAppID assigned by the Chat console when an app is created.
identifier
App admin account. For more information, see the App Admin section in Login Authentication.
usersig
Signature generated by the app admin account. For details, see Generating 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",
  "FollowType":1,
  "StartCursor":"",
  "WantNum":100,
}

Request Fields

Field
Type
Attribute
Description
From_Account
String
Required
User's UserID.
FollowType
Integer
Required
Type to be pulled
1 - Fan
2 - Follow
3 - Mutual follow
StartCursor
String
Required
Start position for paging: Empty on homepage, fill in the NextCursor field returned in the previous page's response for subsequent requests.
WantNum
Integer
Required
Number of entries to fetch: Default returns 100 entries per page, supports up to 1000 entries.

Sample response

{
  "FollowItem": [
    {
      "To_Account": "UserID_002",
      "FollowTime": 1702262118,
      "ProfileItem": [
        {
          "Tag": "Tag_Profile_IM_Nick",
          "Value": "NickNameTest2"
        },
        {
          "Tag": "Tag_Profile_IM_AllowType",
          "Value": "AllowType_Type_DenyAny"
        },
        {
          "Tag": "Tag_Profile_IM_SelfSignature",
          "Value": "I'm Test2"
        },
        {
          "Tag": "Tag_Profile_Custom_Test",
          "Value": "Custom Data2"
        }
      ],
      "profile_sequence": 123
    },
    {
      "To_Account": "UserID_003",
      "FollowTime": 1702262118,
      "ProfileItem": [
        {
          "Tag": "Tag_Profile_IM_Nick",
          "Value": "NickNameTest3"
        },
        {
          "Tag": "Tag_Profile_IM_AllowType",
          "Value": "AllowType_Type_AllowAny"
        },
        {
          "Tag": "Tag_Profile_IM_SelfSignature",
          "Value": "I'm Test3"
        },
        {
          "Tag": "Tag_Profile_Custom_Test",
          "Value": "Custom Data3"
        }
      ],
      "profile_sequence": 111
    }
  ],
  "NextCursor": "",
  "ActionStatus": "OK",
  "ErrorCode": 0,
  "ErrorInfo": "",
  "ErrorDisplay": ""
}

Response Fields

Field
Type
Description
FollowItem
Array
Fans/Follows/Mutual Followers List.
To_Account
String
User's UserID of fans/followers/mutual followers
FollowTime
Integer
Focus on time.
NextCursor
String
Starting position of the next page. If empty, it indicates that all data has been pulled.
ActionStatus
String
Request processing result:
OK: processing successful.
FAIL: processing failure.
ErrorCode
Integer
Error Code:
0: processing successful.
Non-zero: processing failure.
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.
For public error codes (60000 to 79999), please see Error Codes.
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 does not match.
30003
Requested user account does not exist.
30004
Request requires App administrator permissions.
30005
This application does not have the fan and follow feature enabled. To use it, purchase Pro, Pro-plus, or Enterprise Edition and activate it in the Console.
30006
Server internal error, please try again.
30007
Network timeout. Please try again later.

API Debugging Tool

Debug this interface using the REST API Online Debugging Tool.

References

Follow user (v4/follow/follow_add)
Unfollow user (v4/follow/follow_delete)
Check follow relationship (v4/follow/follow_check)
Get user's follow count, fan count, and mutual follow count (v4/follow/follow_get_info)

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback