OPPO开放平台消息推送设置别名管理方法
别名(Alias)是OPPO PUSH提供的一项用户设备映射功能。通过别名,开发者可以为注册ID建立一个方便自己管理的别名,在推送消息时,可以通过别名推送的方式,传入设置好的别名,OPPO PUSH会把别名转化为注册ID并正确下发。OPPO PUSH提供了创建别名,删除别名和查询别名三个与别名相关的管理接口。
环境 | HTTPS请求地址 | 备注 |
---|
生产环境 | https://api-device.push.heytapmobi.com/ | 设备API |
沙箱环境 | 暂无 | |
描述 | 内容 |
---|
接口功能 | 建立registration_id与alias的相互的一对一映射关系,需要注意的是,一个别名仅与一个注册ID构成映射关系,如果对同一个别名注册多个不同的注册ID映射,服务将为最近一次的注册行为建立映射关系并覆盖原有的所有映射。 |
请求方法 | POST |
Content-Type | application/json |
请求编码 | UTF-8 |
请求路径 | /server/v1/device/set_alias |
名称 | 类型 | 必须 | 默认 | 描述 |
---|
registration_id | String | 是 | Null | 注册ID |
alias | String | 是 | Null | 别名内容(仅支持单值,与注册ID一一对应),最大64字符(不能输入分号) |
名称 | 类型 | 必须 | 描述 |
---|
code | Int | 是 | 返回码,请参考公共返回码与接口返回码 |
message | String | 否 | 错误详细信息,不存在则不填 |
data | String | 否 | 返回值,JSON类型,包含响应结构体 |
{
"code": 0,
"message": "success"
}
{
"code": -1,
"message": "Service Currently Unavailable"
}
描述 | 内容 |
---|
接口功能 | 删除别名 |
请求方法 | POST |
Content-Type | application/json |
请求编码 | UTF-8 |
请求路径 | /server/v1/device/delete_alias |
名称 | 类型 | 必须 | 默认 | 描述 |
---|
registration_id | String | 否 | Null | 注册ID registration_id与alias不同时为空 registration_id与alias皆不为空时,registration_id优先于alias |
alias | String | 否 | Null | 别名(仅支持单值,与注册ID一一对应) registration_id与alias不同时为空 registration_id与alias皆不为空时,registration_id优先于alias |
名称 | 类型 | 必须 | 描述 |
---|
code | Int | 是 | 返回码,请参考公共返回码与接口返回码 |
message | String | 否 | 错误详细信息,不存在则不填 |
data | String | 否 | 返回值,JSON类型,包含响应结构体 |
{
"code": 0,
"message": "success"
}
{
"code": -1,
"message": "Service Currently Unavailable"
}
描述 | 内容 |
---|
接口功能 | 查询别名 |
请求方法 | POST |
Content-Type | application/json |
请求编码 | UTF-8 |
请求路径 | /server/v1/device/get_alias |
名称 | 类型 | 必须 | 默认 | 描述 |
---|
registration_id | String | 是 | 无 | 注册ID |
名称 | 类型 | 必须 | 描述 |
---|
code | Int | 是 | 返回码,请参考公共返回码与接口返回码 |
message | String | 否 | 错误详细信息,不存在则不填 |
data | String | 否 | 返回值,JSON类型,包含响应结构体 |
{
"code": 0,
"message": "success",
"data": {
"registrationId": "58ad47319e8d725350a5afd5",
"alias": "AliasName"
}
}
{
"code": -1,
"message": "Service Currently Unavailable"
}