设置应用属性名称

Download

Focus Mode

Font Size

Last updated: 2025-10-23 15:30:53

功能说明
每个应用可以设置自定义的用户属性，最多可以有10个。通过本接口可以设置每个属性的名称，设置完成后，即可用于按用户属性推送等。
请求 URL 示例
https://xxxxxx/v4/timpush/set_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
东京：adminapijpn.im.qcloud.com
法兰克福：adminapiger.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
v4/timpush/set_attr_name
请求接口。
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig。
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员。
sdkappid
创建应用时即时通信控制台分配的 SdkAppid。
random
请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype
固定值为：json
调用频率限制
每秒100次。
请求包示例
设置应用第0号属性表示性别，第1号属性表示城市，第2号属性表示国家。
{
    "AttrNames": {
        "0": "sex",
        "1": "city",
        "2": "country"
    },
    "AttrTypes": {
        "0": 0, // 设置属性对应的账号类型，设置之后不支持修改。
        "1": 0,
        "2": 0
    }
}
请求包字段说明
AttrNames Object 说明：
字段
类型
属性
说明
数字键
String
必填
表示第几个属性（“0”到“9”之间）
属性名
String
必填
属性名最长不超过50字节。应用最多可以有10个推送属性（编号从0到9），用户自定义每个属性的含义
AttrTypes Object 说明：
字段
类型
属性
说明
数字键
String
选填
表示第几个属性（“0”到“9”之间），必须是 AttrNames 中包含的数字键。
账号类型
Integer
选填
相应属性对应的账号类型，默认为 0。一个属性只能对应一种账号类型，详细参见 推送典型场景介绍。
0 账号类型代表：用户登录 IM 账号传递的 UserID。
1 账号类型代表：注册推送服务成功时自动生成的 RegistrationID。
应答包体示例
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}
应答包字段说明
字段
类型
说明
ActionStatus
String
请求处理的结果：
OK：表示处理成功
FAIL：表示失败
ErrorCode
Integer
错误码
ErrorInfo
String
错误信息
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。公共错误码（60000到79999）参见错误码 文档。
本 API 私有错误码如下：
错误码
含义说明
90001
JSON 格式解析失败，请检查请求包是否符合 JSON 规范。
90009
请求需要 App 管理员权限。
91000
服务内部错误，请重试。
接口调试工具
通过 REST API 在线测试 工具调试本接口。
参考
﻿发起全员/标签推送﻿
﻿设置应用属性名称﻿
﻿获取应用属性名称﻿
﻿设置用户属性﻿
﻿删除用户属性﻿
﻿获取用户属性﻿
﻿添加用户标签﻿
﻿获取用户标签﻿
﻿删除用户标签﻿
﻿清空用户标签﻿
﻿推送撤回﻿

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

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

Feedback

tencent cloud

即时通信 IM

设置应用属性名称

功能说明

请求 URL 示例

请求参数说明

调用频率限制

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

接口调试工具

参考

Help and Support

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

字段	类型	属性	说明
数字键	String	必填	表示第几个属性（“0”到“9”之间）
属性名	String	必填	属性名最长不超过50字节。应用最多可以有10个推送属性（编号从0到9），用户自定义每个属性的含义

错误码	含义说明
90001	JSON 格式解析失败，请检查请求包是否符合 JSON 规范。
90009	请求需要 App 管理员权限。
91000	服务内部错误，请重试。