OPPO开放平台消息推送设置别名管理方法

别名(Alias)是OPPO PUSH提供的一项用户设备映射功能。通过别名,开发者可以为注册ID建立一个方便自己管理的别名,在推送消息时,可以通过别名推送的方式

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-Typeapplication/json
请求编码UTF-8
请求路径/server/v1/device/set_alias

请求参数

名称类型必须默认描述
registration_idStringNull注册ID
aliasStringNull别名内容(仅支持单值,与注册ID一一对应),最大64字符(不能输入分号)

响应参数(JSON)

名称类型必须描述
codeInt返回码,请参考公共返回码与接口返回码
messageString错误详细信息,不存在则不填
dataString返回值,JSON类型,包含响应结构体

成功的响应示例

{
    "code": 0,
    "message": "success"
}

失败的响应示例

{
    "code": -1,
    "message": "Service Currently Unavailable"
}

删除别名

接口

描述内容
接口功能删除别名
请求方法POST
Content-Typeapplication/json
请求编码UTF-8
请求路径/server/v1/device/delete_alias

请求参数

名称类型必须默认描述
registration_idStringNull注册ID registration_id与alias不同时为空 registration_id与alias皆不为空时,registration_id优先于alias
aliasStringNull别名(仅支持单值,与注册ID一一对应) registration_id与alias不同时为空 registration_id与alias皆不为空时,registration_id优先于alias

响应参数(JSON)

名称类型必须描述
codeInt返回码,请参考公共返回码与接口返回码
messageString错误详细信息,不存在则不填
dataString返回值,JSON类型,包含响应结构体

成功的响应示例

{
    "code": 0,
    "message": "success"
}

失败的响应示例

{
    "code": -1,
    "message": "Service Currently Unavailable"
}

查询别名

接口

描述内容
接口功能查询别名
请求方法POST
Content-Typeapplication/json
请求编码UTF-8
请求路径/server/v1/device/get_alias

请求参数

名称类型必须默认描述
registration_idString注册ID

响应参数(JSON)

名称类型必须描述
codeInt返回码,请参考公共返回码与接口返回码
messageString错误详细信息,不存在则不填
dataString返回值,JSON类型,包含响应结构体

成功的响应示例

{
    "code": 0,
    "message": "success",
    "data": {
        "registrationId": "58ad47319e8d725350a5afd5",
        "alias": "AliasName"
    }
}

失败的响应示例

{
    "code": -1,
    "message": "Service Currently Unavailable"
}

编辑:yimen,如若转载,请注明出处:https://www.yimenapp.com/kb-yimen/11087/

部分内容来自网络投稿,如有侵权联系立删

(0)
上一篇 2022年11月18日 下午2:53
下一篇 2022年11月18日 下午2:55

相关推荐