Feature Description

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 Invocation 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 lists and describes only the parameters to be modified when this API is invoked. For details on other parameters, see RESTful API Overview.

Maximum invocation frequency

The maximum invocation frequency is 200 times per second.

Request packet examples

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

• Batch format

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

Response packet examples

• Basic format and complete format

  {
   "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 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 RESTful online commissioning tool for APIs to commission this API.

References

• Adding a friend (v4/sns/friend_add)
• Importing a friend (v4/sns/friend_import)
• Updating friends (v4/sns/friend_update)
• Deleting a friend (v4/sns/friend_delete)
• Deleting all friends (v4/sns/friend_delete_all)
• Checking friends (v4/sns/friend_check)
• Pulling a friend (v4/sns/friend_get)