Feature Description

• 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 conflict due to concurrent writes.

API Calling Description

Request URL example

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

Request parameters

The following table lists and describes only the parameters to be modified when this API is called. For details on other parameters, see RESTful API Overview.

Maximum calling frequency

The maximum calling frequency is 200 times per second.

Request packet examples

• Basic form

  {
   "From_Account":"id",
   "AddFriendItem":
   [
       {
           "To_Account":"id1",
           "AddSource":"AddSource_Type_XXXXXXXX"
       }
   ]
  }
  

• Complete form

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

• Batch form

  {
   "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 packet fields

Response packet examples

• Basic form and complete form

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

• Batch form

  {
  "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"],
  "Invalid_Account":["id3"],
  "ActionStatus":"OK",
  "ErrorCode":0,
  "ErrorInfo":"",
  "ErrorDisplay":""
  }
  

Response packet fields

Error Codes

Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response packet represent the actual error code and error information, respectively.
For common error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API.

API Commissioning Tool

Use the online commissioning tool for RESTful APIs to commission this API.

References

• Adding a friend (v4/sns/friend_add)
• Updating friends (v4/sns/friend_update)
• Deleting a friend (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 a specified friend (v4/sns/friend_get_list)