tencent cloud

Feature Overview

• This API is used to import one-way friends in batches.
• We recommend that you import friends for the same user in batches to avoid write conflicts due to concurrent writes.

API Calling Description

Sample request URL

https://xxxxxx/v4/sns/friend_import?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":"id",
    "AddFriendItem":
    [
        {
            "To_Account":"id1",
            "AddSource":"AddSource_Type_XXXXXXXX"
        }
    ]
  }
  

• Response to a complete request

  {
    "From_Account":"id",
    "AddFriendItem":
    [
        {
            "To_Account":"id1",
            "Remark":"remark1",
            "RemarkTime":1420000001,
            "GroupName":["Friends"],
            "AddSource":"AddSource_Type_XXXXXXXX",
            "AddWording":"I'm Test1",
            "AddTime":1420000001,
            "CustomItem":
            [
                {
                    "Tag":"Tag_SNS_Custom_XXXX",
                    "Value":"Test"
                },
                {
                    "Tag":"Tag_SNS_Custom_YYYY",
                    "Value":0
                }
            ]
        }
    ]
  }
  

• Response to a batch request

  {
    "From_Account":"id",
    "AddFriendItem":
    [
        {
            "To_Account":"id1",
            "AddSource":"AddSource_Type_XXXXXXXX"
        },
        {
            "To_Account":"id2",
            "Remark":"remark2",
            "RemarkTime":1420000001,
            "GroupName":["Friends"],
            "AddSource":"AddSource_Type_XXXXXXXX",
            "AddWording":"I'm Test2",
            "AddTime":1420000001
        },
        {
            "To_Account":"id3",
            "Remark":"remark3",
            "RemarkTime":1420000001,
            "GroupName":["Colleagues","Friends"],
            "AddSource":"AddSource_Type_XXXXXXXX",
            "AddWording":"I'm Test3",
            "AddTime":1420000001,
            "CustomItem":
            [
                {
                    "Tag":"Tag_SNS_Custom_XXXX",
                    "Value":"Test"
                },
                {
                    "Tag":"Tag_SNS_Custom_YYYY",
                    "Value":0
                }
            ]
        }
    ]
  }
  

Request fields

Sample response

• Response to a basic or complete request

  {
    "ResultItem":
    [
        {
            "To_Account":"id1",
            "ResultCode":0,
            "ResultInfo":""
        }
    ],
    "ActionStatus":"OK",
    "ErrorCode":0,
    "ErrorInfo":"",
    "ErrorDisplay":""
  }
  

• Response to a batch request

  {
    "ResultItem":
    [
        {
            "To_Account":"id1",
            "ResultCode":0,
            "ResultInfo":""
        },
        {
            "To_Account":"id2",
            "ResultCode":30010,
            "ResultInfo":"Err_SNS_FriendImport_My_Friend_Num_Exceed_Threshold"
        },
        {
            "To_Account":"id3",
            "ResultCode":30002,
            "ResultInfo":"Err_SNS_FriendImport_SdkAppId_Illegal"
        }
    ],
    "Fail_Account":["id2","id3"],
    "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), please 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)
• 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)
• Pulling Specified Friends (v4/sns/friend_get_list)