このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

Checking Follow Relationship

Feature Description
Support batch checking follow relationship
API Call Description
Sample Request URL
https://xxxxxx/v4/follow/follow_check?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
Frankfurt: adminapiger.im.qcloud.com
Mumbai: adminapiind.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
v4/follow/follow_check
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",
  "To_Account": [
    "UserID_002",
    "UserID_003"
  ]
}
Request Fields
Field
Type
Attribute
Description
From_Account
String
Required
Request check the follow relationship between the user and To_Account.
To_Account
Array
Required
To-be-checked list of users, the number of To_Accounts per request should not exceed 100.
Sample response
{
    "ResultItem": [
        {
            "To_Account": "UserID_002",
            "ResultCode": 0,
            "ResultInfo": "",
            "FollowType": 0
        },
        {
            "To_Account": "UserID_003",
            "ResultCode": 0,
            "ResultInfo": "",
            "FollowType": 0
        }
    ],
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ErrorDisplay": ""
}
Response Fields
Field
Type
Description
ResultItem
Array
Verify the result object array.
To_Account
String
UserID of the user who requests the check.
ResultCode
Integer
Processing result of To_Account:
0: Processing is successful.
Non-zero: Processing failed.
ResultInfo
String
Error information of To_Account, this field is empty when successful.
FollowType
Integer
Attention relationship between To_Account and From_Account when verification is successful:
0 - From_Account does not follow To_Account, and To_Account does not follow From_Account.
1 - From_Account does not follow To_Account, but To_Account follows From_Account.
2 - From_Account follows To_Account, but To_Account does not follow From_Account.
3 - From_Account follows To_Account, and To_Account also follows From_Account.
ActionStatus
String
Result of request processing
OK: Processing is successful.
FAIL: Processing failed.
ErrorCode
Integer
Error Code:
0: Processing is successful.
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.
For public error codes (60000 to 79999), 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.
30006
Server internal error, please try again.
30007
Network timeout. Please try again later.
API Debugging Tool
Use the RESTful API online debugging tool to debug this API.
References
Follow user (v4/follow/follow_add)
Unfollow user (v4/follow/follow_delete)
Pull follow, fans, and mutual followers list (v4/follow/follow_get)
Get user's follow count, fan count, and mutual follow count (v4/follow/follow_get_info)
﻿

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_check	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`.

Field	Type	Attribute	Description
From_Account	String	Required	Request check the follow relationship between the user and To_Account.
To_Account	Array	Required	To-be-checked list of users, the number of To_Accounts per request should not exceed 100.

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.
30006	Server internal error, please try again.
30007	Network timeout. Please try again later.