tencent cloud

フィードバック

Setting Application Attribute Names

最終更新日:2024-02-07 17:11:43

    Feature Overview

    You can set a maximum of 10 custom user attributes for each app. 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 and other purposes.

    API Calling Description

    Pushing to all users is available only to the Premium edition. To use it, you need to purchase the Premium edition, go to the console, choose Feature Configuration > Login and Message > Push to all users, and enable the feature.

    Sample request URL

    https://xxxxxx/v4/all_member_push/im_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
    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
    Mumbai: adminapiind.im.qcloud.com
    Silicon Valley: adminapiusa.im.qcloud.com
    Jakarta: adminapiidn.im.qcloud.com
    v4/all_member_push/im_set_attr_name
    Request API
    usersig
    Signature generated in the app admin account. For more information, see Generating UserSig.
    identifier
    The app administration account.
    sdkappid
    SDKAppID assigned by the Chat console when an app is created
    random
    A random 32-bit unsigned integer
    contenttype
    The value is always json.

    Maximum call frequency

    100 times/second

    Sample request

    Set attribute 0 of the app 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 app can have a maximum of 10 push attributes (numbered from 0 to 9), and users can customize the meaning of each attribute.

    Sample response

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

    Response fields

    Field
    Type
    Description
    ActionStatus
    String
    Request result. OK: Successful. 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 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:
    Error Code
    Description
    90001
    Failed to parse the JSON format. Check whether the JSON request meets 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

    お問い合わせ

    カスタマーサービスをご提供できるため、ぜひお気軽にお問い合わせくださいませ。

    テクニカルサポート

    さらにサポートが必要な場合は、サポートチケットを送信して弊社サポートチームにお問い合わせください。24時間365日のサポートをご提供します。

    電話サポート(24 時間365日対応)