tencent cloud

Feedback

Obtaining User Attributes

Last updated: 2024-12-30 16:59:16

    Feature Overview

    Get User Attributes (must be called with an admin account). You can retrieve up to 100 users' attributes at a time. Before use, please first set the application attribute names and then set the user attributes.

    Sample request URL

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

    Request parameters

    Parameter
    Description
    https
    Request protocol: HTTPS
    Request method: POST
    xxxxxx
    The dedicated domain corresponding to the country/region of your 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
    v4/timpush/get_attr
    Request API
    usersig
    The Signature generated by the App admin account. For details, see Generating UserSig
    identifier
    You must be an App admin account. For more details, see App Admins
    sdkappid
    SdkAppid assigned by the Instant Messaging Console when an application is created
    random
    32-bit unsigned integer random number
    contenttype
    Fixed value: json

    Call frequency limit

    100 times per second.

    Sample request packets

    {
    "To_Account": [
    "Mary",
    "xiaoming",
    "xiaohua"
    ]
    }

    Request packet fields

    Field
    Type
    Attribute
    Description
    To_Account
    Array
    Required
    Target User Account List

    Sample response packets

    {
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "UserAttrs": [
    {
    "To_Account": "Mary",
    "Attrs": {
    "sex": "female",
    "city": "NewYork"
    }
    },
    {
    "To_Account": "xiaoming",
    "Attrs": {
    "sex": "male",
    "city": "ShenZhen"
    }
    },
    {
    "To_Account": "xiaohua",
    "Attrs": {}
    }
    ]
    }

    Response packet field description

    Field
    Type
    Description
    ActionStatus
    String
    Processed Request Result:
    OK: Indicates successful processing
    FAIL: Indicates failure
    ErrorCode
    Integer
    Error code
    ErrorInfo
    String
    Error message
    UserAttrs
    Array
    User Tag Content List
    To_Account
    String
    User Account
    Attrs
    Object
    Attribute content: Each attribute is a key-value pair. The key is the attribute name, and the value is the corresponding attribute value for the user. The user's attribute value must not exceed 50 bytes

    Error codes

    Unless a network error occurs (e.g., a 502 error), the HTTP status code for this interface will always be 200.The real error codes and messages are indicated in the response body by ErrorCode and ErrorInfo. For common error codes (60000 to 79999), see the Error Code document.
    Private error codes for this API are as follows:
    Error code
    Description
    90001
    Failed to parse the JSON format. Please ensure the request packet conforms to the JSON specification.
    90018
    The number of requested accounts exceeds the limit.
    91000
    Internal service error, please try again.

    API Debugging Tool

    Use the RESTful API Online Test tool to debug this interface.

    Reference

    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