跳到主要内容

检查好友关系

检查指定用户之间的好友关系。

开通服务

信息托管服务已默认开通,无需额外开通即可调用此接口。

请求方法

POST:https://数据中心域名/friend/check.json

频率限制:每秒钟限 100 次。按批量数量计入频控;例如一次检查 10 个目标用户,计为 10 次调用。

签名规则:所有服务端 API 请求均需要进行规则校验,详见 API 请求签名

正文参数

HTTP 请求正文数据格式为 application/x-www-form-urlencoded,支持以下 HTTP 表单参数:

参数类型必传说明
userIdString操作用户 ID。
targetIdsString[]待检查好友关系的目标用户 ID 列表。多个用户 ID 使用英文逗号分隔,最多支持传入 20 个用户 ID。

请求示例

HTTP
POST /friend/check.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

userId=id1&targetIds=id2,id3,id4

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象:

返回值返回类型说明
codeNumber返回码。200 表示成功。
resultsObject[]检查结果列表。
results[i].userIdString目标用户 ID。
results[i].resultNumber好友关系检查结果:
1:双方不是好友;
2:预留字段,暂不返回;
3:预留字段,暂不返回;
4:双方互为好友。

返回结果示例

HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"code": 200,
"results": [
{
"userId": "id2",
"result": 1
},
{
"userId": "id3",
"result": 4
},
{
"userId": "id4",
"result": 1
}
]
}