功能说明
请求 URL 示例
https://xxxxxx/v4/timpush/set_attr?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/set_attr | 请求接口。 |
usersig | |
identifier | |
sdkappid | 创建应用时即时通信控制台分配的 SdkAppid。 |
random | 32位无符号整数随机数。 |
contenttype | 固定值为: json 。 |
调用频率限制
每秒100次。
请求包示例
{"UserAttrs":[{"To_Account": "379C2F0D-290D-47AE-94D1-919058C39C77", // 注册推送服务成功时自动生成 RegistrationID"Attrs": {"sex": "female","city": "NewYork"}},{"To_Account": "xiaoming","Attrs": {"sex": "male","city": "ShenZhen"}}]}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
To_Account | String | 必填 | 目标用户账号。 |
Attrs | Object | 必填 | 属性集合。每个属性是一个键值对,键为属性名,值为该用户对应的属性值。用户属性值不能超过50字节。 |
应答包体示例
全部账号属性设置成功。
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
部分账号属性设置失败,失败的账号信息在 ErrorList 中。
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"ErrorList": [{"ErrorCode": 90035, // 一种属性只能适用于一种账号类型"To_Account": "379C2F0D-290D-47AE-94D1-919058C39C77"}]}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果: OK:表示处理成功。 FAIL:表示失败。 |
ErrorCode | Integer | 错误码。 |
ErrorInfo | String | 错误信息。 |
ErrorList | Object Array | 设置属性有可能部分用户成功,部分失败。失败账号的错误信息列表。 |
ErrorList 数组中 json Object 字段说明
字段 | 类型 | 说明 |
To_Account | String | 目标用户账号。 |
ErrorCode | Integer | 错误码。 |
ErrorInfo | String | 错误描述,有可能为空。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
接口调试工具
参考
设置应用属性名称
获取应用属性名称
设置用户属性
删除用户属性
获取用户属性
添加用户标签
获取用户标签
删除用户标签
清空用户标签
推送撤回