tencent cloud

Feedback

Setting Application Attribute Names

Last updated: 2024-07-16 11:40:03

    Feature Overview

    You can set a maximum of 10 custom user attributes for each application. This API is used to set the name of each attribute. After you set attribute names, they can be used for push by user attribute.

    Sample Request URL

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

    Request Parameters

    Parameter
    Description
    https
    The request protocol is HTTPS and the request method is POST.
    xxxxxx
    The dedicated domain name corresponding to the country/region of the SDKAppID.
    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/timpush/set_attr_name
    Request API.
    usersig
    The signature generated by the app admin account. For details, see Generating UserSig.
    identifier
    The app admin account.
    sdkappid
    The SDKAppID assigned by the Chat console when an application is created.
    random
    A random 32-bit unsigned integer.
    contenttype
    The value is always json.

    Maximum Call Frequency

    100 times/second

    Sample Request Packets

    Set attribute 0 of the application to sex, attribute 1 to city, and attribute 2 to country.
    {
    "AttrNames": {
    "0": "sex",
    "1": "city",
    "2": "country"
    }
    }

    Request Fields

    Field
    Type
    Required
    Description
    Digital key
    String
    Yes
    Attribute number (0 to 9).
    Attribute name
    String
    Yes
    The attribute name cannot exceed the length limit of 50 bytes. An application can have a maximum of 10 push attributes (numbered from 0 to 9), and users can customize the meaning of each attribute.

    Sample Response Packets

    {
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
    }

    Response Fields

    Field
    Type
    Description
    ActionStatus
    String
    Processing result. OK: succeeded. FAIL: failed.
    ErrorCode
    Integer
    Error code.
    ErrorInfo
    String
    Error information.

    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 packets represent the actual error code and error information. For common error codes (60000 to 79999), see Error Codes. The following table describes the error codes specific to this API:
    Error Code
    Description
    90001
    Failed to parse the JSON format. Check whether the request packets meet JSON specifications.
    90009
    The request requires app admin permissions.
    91000
    Internal service error. Try again.

    API Debugging Tool

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

    References

    
    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