Verifying Friends

Feature Overview
This API is used to check friendship in bulk.
API Calling Description
Sample request URL
https://xxxxxx/v4/sns/friend_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
Domain name corresponding to the country/region where your 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
Silicon Valley: adminapiusa.im.qcloud.com
v4/sns/friend_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 call frequency
200 calls per second
Sample request
{
    "From_Account":"id",
    "To_Account":["id1","id2","id3","id4","id5"],
    "CheckType":"CheckResult_Type_Both"
}
Request fields
Field
Type
Required
Description
From_Account
String
Yes
The UserID of the account that requests to check friendship
To_Account
Array
Yes
The UserIDs of the friends to be checked. Each request cannot contain more than 1,000 UserIDs.
CheckType
String
Yes
Verification mode. For more information, see  Verifying friends.
Sample responses
{
    "InfoItem": [
        {
            "To_Account": "id1",
            "Relation": "CheckResult_Type_BothWay",
            "ResultCode": 0,
            "ResultInfo": ""
        },
        {
            "To_Account": "id2",
            "Relation": "CheckResult_Type_AWithB",
            "ResultCode": 0,
            "ResultInfo": ""
        },
        {
            "To_Account": "id3",
            "Relation": "CheckResult_Type_BWithA",
            "ResultCode": 0,
            "ResultInfo": ""
        },
        {
            "To_Account": "id4",
            "Relation": "CheckResult_Type_NoRelation",
            "ResultCode": 0,
            "ResultInfo": ""
        },
        {
            "To_Account": "id5",
            "Relation": "CheckResult_Type_NoRelation",
            "ResultCode": 30006,
            "ResultInfo": "Err_SNS_FriendCheck_Check_Relation_Exec_Task_Fail"
        }
    ],
    "Fail_Account": ["id5"],
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ErrorDisplay": ""
}
Response fields
Field
Type
Description
InfoItem
Array
The object array of verification results
To_Account
String
The UserID of the account that you requested to check
Relation
String
The friend relationship between To_Account and From_Account upon successful verification. For details, see Verifying friends.
ResultCode
Integer
The process result of To_Account. 0: successful. Other values: failed. For details on non-zero results, see Error Codes.
ResultInfo
String
The error description of To_Account. This field is empty if the request succeeds.
Fail_Account
Array
The users that failed to be verified. This field is only returned when at least one user fails.
ActionStatus
String
The request result. OK: successful. FAIL: failed.
ErrorCode
Integer
Error code. 0: successful. Other values: failed. For details on non-zero results, see Error Codes.
ErrorInfo
String
Detailed error information
ErrorDisplay
String
Detailed information displayed on the client
﻿
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 ResultCode, ResultInfo, ErrorCode, and ErrorInfo.
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
Incorrect request parameter. Check your request according to the error description.
30003
The requested account does not exist.
30004
The request requires app admin permissions.
30006
Internal server error. Try again.
30007
Network timeout. Try again later.
API Debugging Tool
Use the RESTful API online debugging tool to debug this API.
Reference
﻿Adding Friends 
﻿Importing Friends 
﻿Updating Friends 
﻿Deleting Friends 
﻿Deleting All Friends 
﻿Pulling Friends﻿
﻿Pulling Specified Friends﻿

Parameter	Description
xxxxxx	Domain name corresponding to the country/region where your 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` Silicon Valley: `adminapiusa.im.qcloud.com`
v4/sns/friend_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	Required	Description
From_Account	String	Yes	The UserID of the account that requests to check friendship
To_Account	Array	Yes	The UserIDs of the friends to be checked. Each request cannot contain more than 1,000 UserIDs.
CheckType	String	Yes	Verification mode. For more information, see Verifying friends.

Error Code	Description
30001	Incorrect request parameter. Check your request according to the error description.
30003	The requested account does not exist.
30004	The request requires app admin permissions.
30006	Internal server error. Try again.
30007	Network timeout. Try again later.