tencent cloud

Feature Overview

This API allows you to pull the data and profiles of specified friends.
We recommend that you pull no more than 100 friends at a time to avoid response packet failure due to excessive data volume.

API Calling Description

Request URL

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

Request parameters

The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.

Maximum call frequency

200 calls per second

Sample request

• Basic format

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

• Response to a batch request

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

Request fields

Sample response

• Response to a basic or complete request

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

• Pulling specified friends in batches

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

Response fields

Error Codes

The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ResultCode, ResultInfo, ErrorCode, and ErrorInfo.
For public error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API:

API Debugging Tool

Use the RESTful API online debugging tool to debug this API.

References

• Adding Friends (v4/sns/friend_add)
• Importing Friends (v4/sns/friend_import)
• Updating Friends (v4/sns/friend_update)
• Deleting Friends (v4/sns/friend_delete)
• Deleting All Friends (v4/sns/friend_delete_all)
• Verifying Friends (v4/sns/friend_check)
• Pulling Friends (v4/sns/friend_get)