即时通信 IM 拉取指定好友 - 服务端 API

功能说明

支持拉取指定好友的好友数据和资料数据。
建议每次拉取的好友数不超过100，避免因数据量太大导致回包失败。

接口调用说明

请求 URL

https://console.tim.qq.com/v4/sns/friend_get_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。

最高调用频率

200次/秒。

请求包示例

• 基础形式

  {
   "From_Account":"UserID_1",
   "To_Account":
   [
       "UserID_2"
   ],
   "TagList":
   [
       "Tag_Profile_Custom_Test",
       "Tag_Profile_IM_Image",
       "Tag_Profile_IM_Nick",
       "Tag_SNS_Custom_Test",
       "Tag_SNS_IM_Remark",
       "Tag_SNS_IM_Group"
   ]
  }

• 批量形式

  {
   "From_Account":"UserID_1",
   "To_Account":
   [
       "UserID_2",
       "UserID_3",
       "UserID_4"
   ],
   "TagList":
   [
       "Tag_Profile_Custom_Test",
       "Tag_Profile_IM_Image",
       "Tag_Profile_IM_Nick",
       "Tag_SNS_Custom_Test",
       "Tag_SNS_IM_Remark",
       "Tag_SNS_IM_Group"
   ]
  }

请求包字段说明

应答包体示例

• 基础形式、完备形式

  {
   "InfoItem": [
       {
           "To_Account": "UserID_2",
           "SnsProfileItem": [
               {
                   "Tag": "Tag_SNS_IM_Remark",
                   "Value": "remark_2"
               },
               {
                   "Tag": "Tag_SNS_IM_Group",
                   "Value": ["group1","group2"]
               },
               {
                   "Tag": "Tag_Profile_IM_Nick",
                   "Value": "nick_2"
               },
               {
                   "Tag": "Tag_SNS_Custom_Test",
                   "Value": "custom_sns_2"
               },
               {
                   "Tag": "Tag_Profile_Custom_Test",
                   "Value": "custom_profile_2"
               }
           ],
           "ResultCode": 0,
           "ResultInfo": ""
       }
   ],
   "ActionStatus": "OK",
   "ErrorCode": 0,
   "ErrorInfo": "",
   "ErrorDisplay": ""
  }

• 批量拉取指定好友

{
  "InfoItem": [
      {
          "To_Account": "UserID_2",
          "SnsProfileItem": [
              {
                  "Tag": "Tag_SNS_IM_Remark",
                  "Value": "remark_2"
              },
              {
                  "Tag": "Tag_SNS_IM_Group",
                  "Value": ["group1","group2"]
              },
              {
                  "Tag": "Tag_Profile_IM_Nick",
                  "Value": "nick_2"
              },
              {
                  "Tag": "Tag_SNS_Custom_Test",
                  "Value": "custom_sns_2"
              },
              {
                  "Tag": "Tag_Profile_Custom_Test",
                  "Value": "custom_profile_2"
              }
          ],
          "ResultCode": 0,
          "ResultInfo": ""
      },
      {
          "To_Account": "UserID_3",
          "SnsProfileItem": [
              {
                  "Tag": "Tag_SNS_IM_Remark",
                  "Value": "remark_3"
              },
              {
                  "Tag": "Tag_Profile_IM_Nick",
                  "Value": "nick_3"
              },
              {
                  "Tag": "Tag_Profile_Custom_Test",
                  "Value": "custom_profile_3"
              }
          ],
          "ResultCode": 0,
          "ResultInfo": ""
      },
      {
          "To_Account": "UserID_4",
          "ResultCode": 30001,
          "ResultInfo": "Err_SNS_FriendGetList_Friend_Not_Exist"
      }
  ],
  "Fail_Account": [
      "UserID_4"
  ],
  "ActionStatus": "OK",
  "ErrorCode": 0,
  "ErrorInfo": "",
  "ErrorDisplay": ""
}

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ResultCode、ResultInfo、ErrorCode 以及 ErrorInfo 来表示的。
公共错误码（60000到79999）请参见 错误码。
本 API 私有错误码如下：

接口调试工具

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

参考

• 添加好友（v4/sns/friend_add）
• 导入好友（v4/sns/friend_import）
• 更新好友（v4/sns/friend_update）
• 删除好友（v4/sns/friend_delete）
• 删除所有好友（v4/sns/friend_delete_all）
• 校验好友（v4/sns/friend_check）
• 拉取好友（v4/sns/friend_get）