功能说明
请求 URL 示例
https://xxxxxx/v4/timpush/get_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/get_attr | 请求接口。 |
usersig | |
identifier | |
sdkappid | 创建应用时即时通信控制台分配的 SdkAppid。 |
random | 32位无符号整数随机数。 |
contenttype | 固定值为：json。 |
调用频率限制
每秒100次。
请求包示例
{"To_Account": ["Mary","xiaoming","xiaohua"]}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
To_Account | Array | 必填 | 目标用户账号列表。 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"UserAttrs": [{"To_Account": "xiaoming","Attrs": {"sex": "male","city": "ShenZhen"}},{"To_Account": "xiaohua","Attrs": {}}],"ErrorList": [{"ErrorCode": 70107, // 账号不存在"To_Account": "Mary"}]}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果： OK：表示处理成功。 FAIL：表示失败。 |
ErrorCode | Integer | 错误码。 |
ErrorInfo | String | 错误信息。 |
UserAttrs | Object Array | 用户标签内容列表。 |
ErrorList | Object Array | 设置属性有可能部分用户成功，部分失败。失败账号的错误信息列表。 |
UserAttrs 数组中 json Object 字段说明
字段 | 类型 | 说明 |
To_Account | String | 用户账号。 |
Attrs | Object | 属性内容，每个属性是一个键值对，键为属性名，值为该用户对应的属性值。用户属性值不能超过50字节。 |
ErrorList 数组中 json Object 字段说明
字段 | 类型 | 说明 |
To_Account | String | 目标用户账号。 |
ErrorCode | Integer | 错误码。 |
ErrorInfo | String | 错误描述，有可能为空。 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码 | 含义说明 |
90001 | JSON 格式解析失败，请检查请求包是否符合 JSON 规范。 |
90018 | 请求的账号数量超过限制。 |
91000 | 服务内部错误，请重试。 |
接口调试工具
参考
设置应用属性名称
获取应用属性名称
设置用户属性
删除用户属性
获取用户属性
添加用户标签
获取用户标签
删除用户标签
清空用户标签
推送撤回
