标签管理
标签约束:
- UTF8编码、不能以 _ (下划线)开头、小于40个字节
- 只能包含:字母(区分大小写)、数字、汉字、@!#$&*+=.|_
- 每个push_id可以设置多个标签,数量上限1000
添加标签
功能
绑定标签。
接口
请求地址:https://push.safe.baidu.com/push/api/open/v1/tags/add
请求方法:POST
请求
请求示例
curl -H "Content-Type: application/json" -XPOST
"https://push.safe.baidu.com/push/api/open/v1/tags/add?appkey=10001&sign=f808a0f7026345c8e9cc0885268d145d×tamp=1543314814 " -d '{"push_id":"push_id1","tags":["tag1","tag2"]}'
参数说明
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
push_id | 是 | string | push_id |
tags | 是 | json array | 添加的标签列表 |
响应
响应示例
{
"request_id": 45891021,
"code": 0,
"message": ""
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
request_id | int64 | 用于异常排查 |
code | int | 错误码 |
message | string | 错误说明 |
错误码
Code | 说明 |
---|---|
200001 | 标签不符合规范 |
200002 | 此设备标签数量超过上限 |
其他参考全局错误码
删除标签
功能
解绑标签。
接口
请求地址:https://push.safe.baidu.com/push/api/open/v1/tags/delete
请求方法:POST
请求
请求示例
curl -H "Content-Type: application/json" -XPOST
"https://push.safe.baidu.com/push/api/open/v1/tags/delete?appkey=10001&sign=a2779b2cb3d192e83f3a9076b5b94700×tamp=1543314878 " -d '{"push_id":"push_id1","tags":["tag1","tag2"]}'
参数说明
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
push_id | 是 | string | push_id |
tags | 是 | json array | 删除的标签列表 |
响应
响应示例
{
"request_id": 45891021,
"code": 0,
"message": ""
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
request_id | int64 | 用于异常排查 |
code | int | 错误码 |
message | string | 错误说明 |
错误码请参考全局错误码
清除标签
功能
清除push_id已绑定的所有标签。
接口
请求地址:https://push.safe.baidu.com/push/api/open/v1/tags/clear
请求方法:POST
请求
请求示例
curl -H "Content-Type: application/json" -XPOST
"https://push.safe.baidu.com/push/api/open/v1/tags/clear?appkey=10001&sign=78169361d9a3c11013bf8ada390caff9×tamp=1543314957 " -d '{"push_id":"push_id1"}'
参数说明
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
push_id | 是 | string | push_id |
响应
响应示例
{
"request_id": 45891021,
"code": 0,
"message": ""
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
request_id | int64 | 用于异常排查 |
code | int | 错误码 |
message | string | 错误说明 |
错误码请参考全局错误码
查询标签
功能
查询push_id已绑定的所有标签。
接口
请求地址:https://push.safe.baidu.com/push/api/open/v1/tags
请求方法:POST
请求
请求示例
curl -H "Content-Type: application/json" -XPOST
"https://push.safe.baidu.com/push/api/open/v1/tags?appkey=10001&sign=95de2d29de986f407e2eed9a73e5235d×tamp=1543315030 " -d '{"push_id":"push_id1"}'
参数说明
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
push_id | 是 | string | push_id |
响应
响应示例
{
"request_id": 45891021,
"code": 0,
"message": "",
"result": {
"tags": ["tag1","tag2"]
}
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
request_id | int64 | 用于异常排查 |
code | int | 错误码 |
message | string | 错误说明 |
result | json object | - |
result内包含以下字段 | - | - |
tags | json array | 已绑定的标签 |
错误码请参考全局错误码
批量添加标签
功能
批量绑定多个push_id的标签。
接口
请求地址:https://push.safe.baidu.com/push/api/open/v1/tags/add/batch
请求方法:POST
请求
请求示例
curl -H "Content-Type: application/json" -XPOST
"https://push.safe.baidu.com/push/api/open/v1/tags/add/batch?appkey=10001&sign=e9ee3ea21c1bbab69cc87b8ca1695216×tamp=1543316308 " -d '{"push_id1":["tag1","tag2","tag3"],"push_id2":["tag4"]}'
参数说明
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
Post Body | 是 | json object | key为操作的push_id value为需要绑定的标签列表 |
响应
响应示例
{
"request_id": 45891021,
"code": 0,
"message": "",
"result": {
"push_id1": {
"code": 0,
},
"push_id2": {
"code": 200001
}
}
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
request_id | int64 | 用于异常排查 |
code | int | 错误码 |
message | string | 错误说明 |
result | json object | 包含每个push_id对应的操作结果 |
错误码
Code | 说明 |
---|---|
200001 | 标签不符合规范 |
200002 | 此设备标签数量超过上限 |
其它错误码请参考全局错误码
批量删除标签
功能
批量解绑多个push_id的标签
接口
请求地址:https://push.safe.baidu.com/push/api/open/v1/tags/delete/batch
请求方法:POST
请求
请求示例
curl -H "Content-Type: application/json" -XPOST
"https://push.safe.baidu.com/push/api/open/v1/tags/delete/batch?appkey=10001&sign=ccc17f813e80fec9c78e1e7ab2bf930d×tamp=1543316464" -d '{"push_id1":["tag1","tag2","tag3"],"push_id2":["tag4"]}'
参数说明
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
Post Body | 是 | json object | key为操作的push_id value为需要绑定的标签列表 |
响应
响应示例
{
"request_id": 45891021,
"code": 0,
"message": ""
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
request_id | int64 | 用于异常排查 |
code | int | 错误码 |
message | string | 错误说明 |
result | json object | 包含每个push_id对应的操作结果 |
错误码请参考全局错误码
批量清除标签
功能
批量清除多个push_id的所有标签。
接口
请求地址:https://push.safe.baidu.com/push/api/open/v1/tags/clear/batch
请求方法:POST
请求
请求示例
curl -H "Content-Type: application/json" -XPOST
"https://push.safe.baidu.com/push/api/open/v1/tags/clear/batch?appkey=10001&sign=15607f36baaeb7e20108d12295853a62×tamp=1543316586" -d '["push_id1","push_id2","push_id3"]'
参数说明
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
Post Body | 是 | json array | push_id数组 |
响应
响应示例
{
"request_id": 45891021,
"code": 0,
"message": ""
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
request_id | int64 | 用于异常排查 |
code | int | 错误码 |
message | string | 错误说明 |
result | json object | 包含每个push_id对应的操作结果 |
错误码请参考全局错误码
批量查询标签
功能
批量查询多个push_id的所有标签。
接口
请求地址:https://push.safe.baidu.com/push/api/open/v1/tags/batch
请求方法:POST
请求
请求示例
curl -H "Content-Type: application/json" -XPOST
sssssss"https://push.safe.baidu.com/push/api/open/v1/tags/batch?appkey=10001&sign=c77156de8a8325895a7a0bbd0ff4d89b×tamp=1543316664" -d '["push_id1","push_id2","push_id3"]'
参数说明
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
Post Body | 是 | json array | push_id数组 |
响应
响应示例
{
"request_id": 45891021,
"code": 0,
"message": "",
"result": {
"push_id1": {
"code": 0,
"tags": ["tag1","tag2"]
},
"push_id2": {
"code": 1000
}
}
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
request_id | int64 | 用于异常排查 |
code | int | 错误码 |
message | string | 错误说明 |
result | json object | 包含每个push_id对应的操作结果 |
result内包含以下字段 | - | - |
code | int | push_id对应的操作结果 |
tags | json array | 已绑定的标签 |
错误码请参考全局错误码