检查关注关系

功能说明

支持批量检查关注关系。

接口调用说明

请求 URL 示例

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

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名:
中国:console.tim.qq.com
新加坡:adminapisgp.im.qcloud.com
首尔: adminapikr.im.qcloud.com
法兰克福:adminapiger.im.qcloud.com
孟买:adminapiind.im.qcloud.com
硅谷:adminapiusa.im.qcloud.com
v4/follow/follow_check
请求接口。
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID。
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295。
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

{
"From_Account": "UserID_001",
"To_Account": [
"UserID_002",
"UserID_003"
]
}

请求包字段说明

字段
类型
属性
说明
From_Account
String
必填
请求检查该用户与 To_Account 之间的关注关系。
To_Account
Array
必填
待检查的用户列表,单次请求的 To_Account 数不得超过100。

应答包体示例

{
"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": ""
}

应答包字段说明

字段
类型
说明
ResultItem
Array
校验结果对象数组。
To_Account
String
请求检查的用户的 UserID。
ResultCode
Integer
To_Account 的处理结果:
0:处理成功。
非0:处理失败。
ResultInfo
String
To_Account 的错误描述信息,成功时该字段为空。
FollowType
Integer
校验成功时 To_Account 与 From_Account 之间的关注关系:
0 - From_Account 没有关注 To_Account,To_Account 也没有关注 From_Account。
1 - From_Account 没有关注 To_Account,To_Account 关注了 From_Account。
2 - From_Account 关注了 To_Account,To_Account 没有关注 From_Account。
3 - From_Account 关注了 To_Account,To_Account 也关注了 From_Account。
ActionStatus
String
请求处理的结果
OK:处理成功
FAIL:处理失败。
ErrorCode
Integer
错误码:
0:处理成功。
非0:处理失败。
ErrorInfo
String
详细错误信息。

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ResultCode、ResultInfo、ErrorCode 以及 ErrorInfo 来表示的。 公共错误码(60000到79999)请参见 错误码。 本 API 私有错误码如下:
错误码
描述
30001
请求参数错误,请根据错误描述检查请求参数。
30002
SDKAppID 不匹配。
30003
请求的用户账号不存在。
30004
请求需要 App 管理员权限。
30006
服务器内部错误,请重试。
30007
网络超时,请稍后重试。

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考

关注用户(v4/follow/follow_add
取消关注用户(v4/follow/follow_delete
拉取关注、粉丝与互关列表(v4/follow/follow_get
获取用户的关注、粉丝与互关数(v4/follow/follow_get_info