tencent cloud

Feedback

Setting Profiles

Last updated: 2024-10-10 10:33:28

    Feature Overview

    This API is used to set standard profile fields and custom profile fields.

    API Calling Description

    Sample request URL

    https://xxxxxx/v4/profile/portrait_set?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.
    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
    App admin account. For more information, see the App Admin section in Login Authentication.
    usersig
    Signature generated by the app admin account. For details, see Generating UserSig.
    random
    A random 32-bit unsigned integer ranging from 0 to 4294967295.
    contenttype
    Request format, which should always be json.

    Maximum call frequency

    200 calls per second

    Sample request

    {
    "From_Account":"id",
    "ProfileItem":
    [
    {
    "Tag":"Tag_Profile_IM_Nick",
    "Value":"MyNickName"
    }
    ]
    }

    Request fields

    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
    Value of the profile field to be set. For details, see Profile Fields.

    Sample response

    {
    "ActionStatus":"FAIL",
    "ErrorCode":40001,
    "ErrorInfo":"Err_Profile_Comm_Decode_Fail",
    "ErrorDisplay":""
    }

    Response fields

    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.

    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 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
    Incorrect value of the standard profile field. For more information, see Standard Profile Fields.
    40610
    Incorrect value type of the standard profile field. For more information, see Standard Profile Fields.

    API Debugging Tool

    Use the RESTful API online debugging tool to debug this API.

    References

    Pulling profiles (v4/profile/portrait_get)
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support