Feature Description

• This API is used to pull profile fields of friends and other users.
• This API can pull standard profile fields and custom profile fields.
• We recommend that profile fields of no more than 100 users are pulled each time to prevent a response packet failure due to excessive data.
• Ensure that all accounts in the request are imported into the IM console. Otherwise, an error will be displayed at the IM backend.

Call Description

Sample request URL

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

Request parameters

The following table only describes the parameters that are modified when this API is called. For more information about other parameters, please see RESTful API Overview.

Maximum call frequency

200 times/second

Sample request packet

• Read a profile field of a user.

  {
   "To_Account":["id1"],
   "TagList":
   [
       "Tag_Profile_IM_Nick"
   ]
  }
  

• Read multiple profile fields of a user.

  {
   "To_Account":["id1"],
   "TagList":
   [
       "Tag_Profile_IM_Nick",
       "Tag_Profile_IM_AllowType",
       "Tag_Profile_IM_SelfSignature",
       "Tag_Profile_Custom_Test"
   ]
  }
  

• Read a profile field of multiple users.

  {
   "To_Account":["id1","id2","id3"],
   "TagList":
   [
       "Tag_Profile_IM_Nick"
   ]
  }
  

• Read multiple profile fields of multiple users.

  {
   "To_Account":["id1","id2","id3","id4"],
   "TagList":
   [
       "Tag_Profile_IM_Nick",
       "Tag_Profile_IM_AllowType",
       "Tag_Profile_IM_SelfSignature",
       "Tag_Profile_Custom_Test"
   ]
  }
  

Request packet fields

Sample response packet body

• Read a profile field of a user.

  {
   "UserProfileItem":
   [
       {
           "To_Account":"id1",
           "ProfileItem":
           [
               {
                   "Tag":"Tag_Profile_IM_Nick",
                   "Value":"NickNameTest1"
               }
           ],
           "ResultCode":0,
           "ResultInfo":""
       }
   ],
   "ActionStatus":"OK",
   "ErrorCode":0,
   "ErrorInfo":"",
   "ErrorDisplay":""
  }
  

• Read multiple profile fields of a user.

  {
   "UserProfileItem":
   [
       {
           "To_Account":"id1",
           "ProfileItem":
           [
               {
                   "Tag":"Tag_Profile_IM_Nick",
                   "Value":"NickNameTest1"
               },
               {
                   "Tag":"Tag_Profile_IM_AllowType",
                   "Value":"AllowType_Type_NeedConfirm"
               },
               {
                   "Tag":"Tag_Profile_IM_SelfSignature",
                   "Value":"I'm Test1"
               },
               {
                   "Tag":"Tag_Profile_Custom_Test",
                   "Value":"Custom Data1"
               }
           ],
           "ResultCode":0,
           "ResultInfo":""
       }
   ],
   "ActionStatus":"OK",
   "ErrorCode":0,
   "ErrorInfo":"",
   "ErrorDisplay":""
  }
  

• Read a profile field of multiple users.

  {
   "UserProfileItem":
   [
       {
           "To_Account":"id1",
           "ProfileItem":
           [
               {
                   "Tag":"Tag_Profile_IM_Nick",
                   "Value":"NickNameTest1"
               }
           ],
           "ResultCode":0,
           "ResultInfo":""
       },
       {
           "To_Account":"id2",
           "ProfileItem":
           [
               {
                   "Tag":"Tag_Profile_IM_Nick",
                   "Value":"NickNameTest2"
               }
           ],
           "ResultCode":0,
           "ResultInfo":""
       },
       {
           "To_Account":"id3",
           "ProfileItem":
           [
               {
                   "Tag":"Tag_Profile_IM_Nick",
                   "Value":"NickNameTest3"
               }
           ],
           "ResultCode":0,
           "ResultInfo":""
       }
   ],
   "ActionStatus":"OK",
   "ErrorCode":0,
   "ErrorInfo":"",
   "ErrorDisplay":""
  }
  

• Read multiple profile fields of multiple users.

  {
   "UserProfileItem":
   [
       {
           "To_Account":"id1",
           "ProfileItem":
           [
               {
                   "Tag":"Tag_Profile_IM_Nick",
                   "Value":"NickNameTest1"
               },
               {
                   "Tag":"Tag_Profile_IM_AllowType",
                   "Value":"AllowType_Type_NeedConfirm"
               },
               {
                   "Tag":"Tag_Profile_IM_SelfSignature",
                   "Value":"I'm Test1"
               },
               {
                   "Tag":"Tag_Profile_Custom_Test",
                   "Value":"Custom Data1"
               }
           ],
           "ResultCode":0,
           "ResultInfo":""
       },
       {
           "To_Account":"id2",
           "ProfileItem":
           [
               {
                   "Tag":"Tag_Profile_IM_Nick",
                   "Value":"NickNameTest2"
               },
               {
                   "Tag":"Tag_Profile_IM_AllowType",
                   "Value":"AllowType_Type_DenyAny"
               },
               {
                   "Tag":"Tag_Profile_IM_SelfSignature",
                   "Value":"I'm Test2"
               },
               {
                   "Tag":"Tag_Profile_Custom_Test",
                   "Value":"Custom Data2"
               }
           ],
           "ResultCode":0,
           "ResultInfo":""
       },
       {
           "To_Account":"id3",
           "ProfileItem":
           [
               {
                   "Tag":"Tag_Profile_IM_Nick",
                   "Value":"NickNameTest3"
               },
               {
                   "Tag":"Tag_Profile_IM_AllowType",
                   "Value":"AllowType_Type_AllowAny"
               },
               {
                   "Tag":"Tag_Profile_IM_SelfSignature",
                   "Value":"I'm Test3"
               },
               {
                   "Tag":"Tag_Profile_Custom_Test",
                   "Value":"Custom Data3"
               }
           ],
           "ResultCode":0,
           "ResultInfo":""
       },
       {
           "To_Account":"id4",
           "ResultCode":40006,
           "ResultInfo":"Err_Profile_PortraitGet_Read_Custom_Data_Fail"
       }
   ],
   "Fail_Account":["id4"],
   "ActionStatus":"OK",
   "ErrorCode":0,
   "ErrorInfo":"",
   "ErrorDisplay":""
  }
  

Response 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.
For public error codes 60000 to 79999, please see Error Codes.
The following table describes the error codes specific to this API.

Commissioning Tool

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

Reference

Configuring Profiles (v4/profile/portrait_set).