别名管理
更新时间:2020-05-10
别名约束:
- UTF8编码、不能以 _ (下划线)开头、小于40个字节
- 只能包含:字母(区分大小写)、数字、汉字、@!#$&*+=.|_
- 一个push_id只能绑定一个别名,重复绑定则会覆盖
绑定别名
功能
绑定别名。
接口
请求地址:https://push.safe.baidu.com/push/api/open/v1/alias/add
请求方法:POST
请求
请求示例
curl -H "Content-Type: application/json" -XPOST
"https://push.safe.baidu.com/push/api/open/v1/alias/add?appkey=10001&sign=79b3b29b659ab203bc20a8571b2a2743×tamp=1543316741" -d '{"push_id":"push_id1","alias":"alias1"}'
参数说明
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
push_id | 是 | string | push_id |
alias | 是 | string | 绑定的别名 |
响应
响应示例
{
"request_id": 45891021,
"code": 0,
"message": ""
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
request_id | int64 | 用于异常排查 |
code | int | 错误码 |
message | string | 错误说明 |
错误码
Code | 说明 |
---|---|
100001 | 别名格式错误,请参考别名约束 |
其它错误码请参考全局错误码
解绑别名
功能
解绑别名。
接口
请求地址:https://push.safe.baidu.com/push/api/open/v1/alias/clear
请求方法:POST
请求
请求示例
curl -H "Content-Type: application/json" -XPOST
"https://push.safe.baidu.com/push/api/open/v1/alias/clear?appkey=10001&sign=56d5f1d42ce463cefaca562b6bbc7695×tamp=1543316807" -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/alias
请求方法:POST
请求
请求示例
curl -H "Content-Type: application/json" -XPOST
"https://push.safe.baidu.com/push/api/open/v1/alias?appkey=10001&sign=e76b11bdf975b324790fca5ec007871c×tamp=1543316860" -d '{"push_id":"push_id1"}'
参数说明
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
push_id | 是 | string | push_id |
响应
响应示例
{
"request_id": 45891021,
"code": 0,
"message": "",
"result": {
"alias": "alias1"
}
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
request_id | int64 | 用于异常排查 |
code | int | 错误码 |
message | string | 错误说明 |
result | json object | - |
result内包含以下字段 | - | - |
alias | string | 绑定的别名 |
错误码
Code | 说明 |
---|---|
110001 | 设备尚未绑定别名 |
其它错误码请参考全局错误码
批量绑定别名
功能
批量绑定多个push_id的别名。
接口
请求地址:https://push.safe.baidu.com/push/api/open/v1/alias/add/batch
请求方法:POST
请求
请求示例
curl -H "Content-Type: application/json" -XPOST
"https://push.safe.baidu.com/push/api/open/v1/alias/add/batch?appkey=10001&sign=5bf26f46d5eaf944158cec78f6b4b06e×tamp=1543316932" -d '{"push_id1":"alias1","push_id2":"alias2"}'
参数说明
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
Post Body | 是 | json object | key为操作的push_id value为需要绑定的别名 |
响应
响应示例
{
"request_id": 45891021,
"code": 0,
"message": "",
"result": {
"push_id1": {
"code": 0,
},
"push_id2": {
"code": 20001
}
}
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
request_id | int64 | 用于异常排查 |
code | int | 错误码 |
message | string | 错误说明 |
result | json object | 包含每个push_id对应的操作结果 |
错误码
Code | 说明 |
---|---|
100001 | 别名格式错误,请参考别名约束 |
其它错误码请参考全局错误码
批量解绑别名
功能
批量解绑多个push_id的别名。
接口
请求地址:https://push.safe.baidu.com/push/api/open/v1/alias/clear/batch
请求方法:POST
请求
请求示例
curl -H "Content-Type: application/json" -XPOST
"https://push.safe.baidu.com/push/api/open/v1/alias/clear/batch?appkey=10001&sign=7c7a27b5d29962063d28ffaeda04a675×tamp=1543317301" -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/alias/batch
请求方法:POST
请求
请求示例
curl -H "Content-Type: application/json" -XPOST
"https://push.safe.baidu.com/push/api/open/v1/alias/batch?appkey=10001&sign=daec5b2366a4302073e6382a78a8c78c×tamp=1543317369" -d '["push_id1","push_id2"]'
参数说明
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
Post Body | 是 | json array | push_id数组 |
响应
响应示例
{
"request_id": 45891021,
"code": 0,
"message": "",
"result": {
"push_id1": {
"code": 0,
"alias": "alias1"
},
"push_id2": {
"code": 1000
}
}
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
request_id | int64 | 用于异常排查 |
code | int | 错误码 |
message | string | 错误说明 |
result | json object | 包含每个push_id对应的操作结果 |
result内包含以下字段 | - | - |
code | int | push_id对应的操作结果 |
alias | string | 绑定的别名 |
其它错误码请参考全局错误码