https://xxxxxx/v4/profile/portrait_set?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Parameter | Description |
xxxxxx | Domain name corresponding to the country/region where your SDKAppID is located. China: console.tim.qq.com Singapore: adminapisgp.im.qcloud.com Seoul: adminapikr.im.qcloud.com Frankfurt: adminapiger.im.qcloud.com Silicon Valley: adminapiusa.im.qcloud.com Jakarta: adminapiidn.im.qcloud.com |
v4/profile/portrait_set | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format, which should always be json . |
{"From_Account":"id","ProfileItem":[{"Tag":"Tag_Profile_IM_Nick","Value":"MyNickName"}]}
Field | Type | Required | Description |
From_Account | String | Yes | UserID of the user whose profile needs to be set |
ProfileItem | Array | Yes | Profile object array of the target user. Each object in the array contains a tag and a value. |
Tag | String | Yes | Profile field to be set. Profile fields that can be set include:<br>1. Standard Profile Fields<br>2. Custom Profile Fields |
Value | uint64_t/string/bytes | Yes |
{"ActionStatus":"FAIL","ErrorCode":40001,"ErrorInfo":"Err_Profile_Comm_Decode_Fail","ErrorDisplay":""}
Field | Type | Description |
ActionStatus | String | The result of the request. OK means the request was successful. FAIL means the request failed. |
ErrorCode | Integer | Error code. 0 : Successful; other values: Failed |
ErrorInfo | String | Detailed error information. |
ErrorDisplay | String | Detailed information displayed on the client. |
ErrorCode
and ErrorInfo
respectively.
For public error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API:Error Code | Description |
40001 | Incorrect request parameter. Check your request according to the error description. |
40003 | The requested account does not exist. |
40004 | The request requires app admin permission. |
40006 | Internal server error. Try again later. |
40008 | No permission to write profile fields. |
40009 | The tag of a profile field does not exist. |
40601 | The value of the profile field exceeds the length limit of 500 bytes. |
40605 | |
40610 | Incorrect value type of the standard profile field. For more information, see Standard Profile Fields. |
Was this page helpful?