文档中心>移动推送

API 迁移指南

最近更新时间:2024-08-15 15:46:52

我的收藏
本文主要介绍了信鸽版本到移动推送 TPNS 版本的接口迁移说明,包括 V3 和 V2 的推送接口、账号接口和标签接口的差异。

请求域名地址变动说明

请求参数变动说明
协议字段
字段含义说明
变动说明
openapi.xg.qq.com
域名
请根据选择的服务接入点选择对应的域名地址:
广州服务接入点:api.tpns.tencent.com
中国香港服务接入点:api.tpns.hk.tencent.com
新加坡服务接入点:api.tpns.sgp.tencent.com
上海服务接入点:api.tpns.sh.tencent.com

V3 接口协议变动说明

移动推送 TPNS 版本 V3 接口协议格式 对比 信鸽版本V3接口协议格式基本相同。 协议中部分字段格式以及命名有变化,具体差异如下:

鉴权方式

信鸽版本使用 AppId + SecretKey 进行 Basic Auth 鉴权。(信鸽版本鉴权说明)
移动推送 TPNS 版本使用 AccessId + SecretKey 进行 Basic Auth 鉴权。(移动推送 TPNS 版本鉴权说明)
说明
移动推送 TPNS 版本没有对应 AppId 字段, 需要使用对应的应用 id AccessId 和密钥 SecretKey 进行鉴权

推送接口

移动推送 TPNS 版本推送接口协议 格式和 信鸽版本 基本相同, 主要区别如下:
请求参数变动说明
协议字段
字段含义说明
信鸽版
移动推送 TPNS 版
custom_content
Android 推送自定义参数
字段格式: json
字段格式:需要序列化为 json string
custom_content
iOS 推送自定义参数
字段格式: json
字段格式:需要序列化为 json string
push_id
账号列表推送和设备列表推送时,需要填写的推送任务 ID
账号列表推送和设备列表推送时,第一次推送该值填0,系统会创建对应的推送任务,并且返回对应的 pushid:123,后续推送push_id填123(同一个文案)表示使用与123 id 对应的文案进行推送
不再支持该字段对应功能

账号绑定接口

移动推送 TPNS 版本账号绑定协议格式信鸽版本 完全相同,无需特别改动。

账号查询接口

移动推送 TPNS 版本账号查询协议格式信鸽版本 基本相同,主要区别如下:
响应参数变动说明
协议字段
字段含义说明
变动说明
ret_code
操作返回码
字段名变更为 retCode
err_msg
操作响应消息
字段名变更为 errMsg

标签绑定接口

移动推送 TPNS 版本标签绑定协议格式信鸽版本 基本相同,主要区别如下:
请求参数变动说明
协议字段
字段含义说明
信鸽版
移动推送 TPNS 版
tag_token_list
当进行标签和设备批量绑定/解绑时,提供需要绑定/解绑的标签设备列表,operator_type =9,10时必填
字段格式:[["tag1","token1"],["tag2","token2"]],每个对里面标签在前,token在后, 列表中每个元素为 jsonArray
字段格式:[{"tag":"tag123", "token":"token123"}],列表中每个元素为 jsonObject

返回码

移动推送 TPNS 版本错误码是一套全新的返回码,和信鸽版本不同。 信鸽版本返回码定义参见:信鸽版本返回码 移动推送 TPNS 版本返回码定义参见:移动推送 TPNS 版本返回码

V2 接口协议变动说明

移动推送 TPNS 版本不再支持V2 协议接口
V2 版本对应的V3 版本接口参考如下:
V2接口
V2接口url
V3 接口
V3 接口 URL
接口定义说明
全量推送
/v2/push/all_device
推送接口
/v3/push/app
标签推送
/v2/push/tags_device
推送接口
/v3/push/app
账号群推
/v2/push/account_list
推送接口
/v3/push/app
设备单推
/v2/push/single_device
推送接口
/v3/push/app
账号单推
/v2/push/single_account
推送接口
/v3/push/app
超大批量账号推送
/v2/push/account_list_multiple
不支持,可使用号码包推送替代
-
-
超大批量设备推送
v2/push/device_list_multiple
不支持,可使用号码包推送替代
-
-
批量新增标签
/v2/tags/batch_set
标签绑定接口
/v3/device/tag
批量删除标签
/v2/tags/batch_del
标签绑定接口
/v3/device/tag