功能说明
管理员给用户添加标签。
注意:
每次请求最多只能给100个用户添加标签,请求体中单个用户添加标签数最多为10个。
单个用户可设置最大标签数为100个,若用户当前标签超过100,则添加新标签之前请先删除旧标签。
应用最大可以设置的标签数为1000个,即所有用户的标签加在一起去重复后的数量为最多1000个。
单个标签最大长度为50字节。
请求 URL 示例
https://xxxxxx/v4/timpush/add_tag?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 |
v4/timpush/add_tag | 请求接口 |
usersig | |
identifier | |
sdkappid | 创建应用时即时通信控制台分配的 SdkAppid |
random | 32位无符号整数随机数 |
contenttype | 固定值为:json |
调用频率限制
每秒100次。
请求包示例
{"UserTags": [{"To_Account": "xiaoming","Tags": ["黄金会员", "周卡用户"]},{"To_Account": "xiaohong","Tags": ["白金会员", "月卡用户"]}]}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
To_Account | String | 必填 | 目标用户账号 |
Tags | Array | 必填 | 标签数组,单个标签最大长度不超过50字节,每一个标签都是一个 string 类型的字符串 |
应答包体示例
{"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 管理员权限。 |
90018 | 请求的账号数量超过限制。 |
91000 | 服务内部错误,请重试。 |
接口调试工具
参考
设置应用属性名称
获取应用属性名称
设置用户属性
删除用户属性
获取用户属性
添加用户标签
获取用户标签
删除用户标签
清空用户标签
推送撤回