tencent cloud

即时通信 IM

Documentation即时通信 IM推送服务（Push）服务端 API获取应用属性名称

获取应用属性名称

Download
Focus Mode
Font Size
Last updated: 2026-05-25 19:49:32

功能说明

管理员获取应用属性名称。使用前请先 设置应用属性名称 。

请求 URL 示例

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

请求参数说明

参数
说明
https
请求协议为 HTTPS
请求方式为 POST
xxxxxx
SDKAppID 所在国家/地区对应的专属域名。
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
首尔：adminapikr.im.qcloud.com
法兰克福：adminapiger.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
利雅得：adminapiksa.im.qcloud.com
v4/timpush/get_attr_name
请求接口。
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig。
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员。
sdkappid
创建应用时即时通信控制台分配的 SdkAppid
random
请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype
固定值为：json。

调用频率限制

每秒100次。

请求包示例

{}

请求包字段说明

无。

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "AttrNames": {
        "0": "sex",
        "1": "city",
        "2": "country"
    },
    "AttrTypes": {
        "0": 0, 
        "1": 0,
        "2": 1 // 数字键2对应属性country，改属性只能被类型为1账号设置（注册推送服务成功时自动生成该 RegistrationID）
    }
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果：
OK：表示处理成功。
FAIL：表示失败。
ErrorCode
Integer
错误码。
ErrorInfo
String
错误信息。
AttrNames
Object
包含多个键对。每对键值对，表示第几个属性对应的名称。例如"0":"xxx"表示第0号属性的名称是 xxx。
AttrTypes
Object
包含多个键对。每对键值对，表示第几个属性对应的账号类型。
"0": 0表示第0号属性的账号类型是0（Chat 账号类型）。
"0": 1表示第0号属性的账号类型是1（注册推送服务成功时自动生成的 RegistrationID）。

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。公共错误码（60000到79999）参见 错误码 文档。 本 API 私有错误码如下：
错误码
含义说明
90001
JSON 格式解析失败，请检查请求包是否符合 JSON 规范。
90009
请求需要 App 管理员权限。
90018
请求的账号数量超过限制。
91000
服务内部错误，请重试。

接口调试工具

通过 REST API 在线测试 工具调试本接口。

参考

发起全员/标签推送
单发推送
获取应用属性名称
设置应用属性名称
获取用户属性
设置用户属性
删除用户属性
获取用户标签
添加用户标签
删除用户标签
清空用户标签
推送撤回

Previous Topic: 设置应用属性名称Next Topic: 获取用户属性

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback