支持批量校验好友关系。
https://xxxxxx/v4/sns/friend_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/sns/friend_check | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | 必须为 App 管理员帐号,更多详情请参见 App 管理员 |
usersig | App 管理员帐号生成的签名,具体操作请参见 生成 UserSig |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为json |
200次/秒。
{
"From_Account":"id",
"To_Account":["id1","id2","id3","id4","id5"],
"CheckType":"CheckResult_Type_Both"
}
字段 | 类型 | 属性 | 说明 |
---|---|---|---|
From_Account | String | 必填 | 需要校验该 UserID 的好友 |
To_Account | Array | 必填 | 请求校验的好友的 UserID 列表,单次请求的 To_Account 数不得超过1000 |
CheckType | String | 必填 | 校验模式,详情可参见 校验好友 |
{
"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": ""
}
字段 | 类型 | 说明 |
---|---|---|
InfoItem | Array | 校验结果对象数组 |
To_Account | String | 请求校验的用户的 UserID |
Relation | String | 校验成功时 To_Account 与 From_Account 之间的好友关系,详情可参见 校验好友 |
ResultCode | Integer | To_Account 的处理结果,0表示成功,非0表示失败,非0取值的详细描述请参见 错误码说明 |
ResultInfo | String | To_Account 的错误描述信息,成功时该字段为空 |
Fail_Account | Array | 返回处理失败的用户列表,仅当存在失败用户时才返回该字段 |
ActionStatus | String | 请求包的处理结果,OK 表示处理成功,FAIL 表示失败 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败,非0取值的详细描述请参见 错误码说明 |
ErrorInfo | String | 详细错误信息 |
ErrorDisplay | String | 详细的客户端展示信息 |
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ResultCode、ResultInfo、ErrorCode 以及 ErrorInfo 来表示的。
公共错误码(60000到79999)请参见 错误码。
本 API 私有错误码如下:
错误码 | 描述 |
---|---|
30001 | 请求参数错误,请根据错误描述检查请求参数 |
30003 | 请求的用户帐号不存在 |
30004 | 请求需要 App 管理员权限 |
30006 | 服务器内部错误,请重试 |
30007 | 网络超时,请稍后重试 |
通过 REST API 在线调试工具 调试本接口。
本页内容是否解决了您的问题?