校验好友

功能说明

批量检查用户是否在好友列表中。

调用频率上限

100 次/秒/App Key

请求 URL

POST https://{host}/{org_name}/{app_name}/contacts/check

关于请求 URL 中的参数说明，详见 请求 URL 参数介绍。

请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token

curl -X POST 'https://XXXX/XXXX/XXXX/contacts/check'  \
-H 'Content-Type: application/json'   \
-H 'Accept: application/json'   \
-H 'Authorization: Bearer <YourAppToken>'    \
-d '{
    "username": "user1", 
    "check_list": [ 
    "user2",
    "user3"
    ]
  }'

请求 header 参数

关于 Content-Type、Accept 和 Authorization 字段的说明，详见 请求 header 参数说明。

请求 body 参数

请求包体为 JSON Object 类型，包含以下字段：

参数	类型	是否必需	描述
username	String	是	当前用户 ID。批量检查该用户 ID 的好友。
check_list	JSON Array	是	需要检查的好友的用户 ID，一次最多可校验 100 个用户 ID。

响应示例

{
  "action": "post",
  "application": "8bXXXX402",
  "path": "/contacts/check",
  "uri": "https://XXXX/XXXX/XXXX/contacts/check",
  "entities": [
    {
        "username":"user2",
        "relation":"friend"
    },
    {
        "username":"user3",
        "relation":"not_friend"
    }
  ],
  "timestamp": 1542598913819,
  "duration": 63,
  "organization": "XXXX",
  "applicationName": "testapp"
}

响应 body 字段

如果返回的 HTTP 状态码为 200，表示请求成功，，响应包体中 data 字段的说明如下：

字段	类型	描述
entities	JSON Array	校验结果的详情。
- username	String	系统内为用户生成的系统内唯一标识。
- relation	String	是否为好友： - friend：是 - not_friend：否

其他字段的说明如下：

字段	类型	描述
action	String	请求方法。
application	String	系统内为应用生成的唯一标识，开发者无需关心。
path	String	请求路径，属于请求 URL 的一部分，开发者无需关注。
uri	String	请求 URL。
timestamp	Long	HTTP 响应的 Unix 时间戳，单位为毫秒。
duration	Long	从发送 HTTP 请求到响应的时长, 单位为毫秒。
organization	String	环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 org_name 相同。
applicationName	String	你在环信控制台创建应用时填入的应用名称，与请求参数 app_name 相同。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 错误码 了解可能的原因。

错误码

如果返回的 HTTP 状态码非 200，表示请求失败，可能提示以下错误码：

HTTP 状态码	错误类型	错误提示	可能原因	处理建议
401	unauthorized	Unable to authenticate (OAuth)	Token 不合法，可能过期或 Token 错误。	使用新的 Token 访问。
429	reach_limit	This request has reached api limit.	接口调用超过频率限制。	联系商务调整限流或者控制调用速率。
403	forbidden_service_operation	Service operation not allowed	app 或用户被封禁。	先解禁 app 或用户后再调用该接口。
400	illegal_argument	username cannot be blank	校验的用户 username 不能传空。	确认 username 参数是否正确填写。
400	illegal_argument	check_list size must be between 1 and 100	被校验的用户列表只能包含 1 到 100 个用户。	确认 check_list 参数是否正确填写。

关于其他错误，你可以参考 错误码页面 了解可能的原因。