本文主要介绍了信鸽版本到移动推送 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 版本没有对应 AppId 字段, 需要使用对应的应用 id
AccessId
和密钥 SecretKey
进行鉴权。推送接口
请求参数变动说明
协议字段 | 字段含义说明 | 信鸽版 | 移动推送 TPNS 版 |
custom_content | Android 推送自定义参数 | 字段格式: json | 字段格式:需要序列化为 json string |
custom_content | iOS 推送自定义参数 | 字段格式: json | 字段格式:需要序列化为 json string |
push_id | 账号列表推送和设备列表推送时,需要填写的推送任务 ID | 账号列表推送和设备列表推送时,第一次推送该值填0,系统会创建对应的推送任务,并且返回对应的 pushid:123,后续推送push_id填123(同一个文案)表示使用与123 id 对应的文案进行推送 | 不再支持该字段对应功能 |
账号绑定接口
账号查询接口
响应参数变动说明
协议字段 | 字段含义说明 | 变动说明 |
ret_code | 操作返回码 | 字段名变更为 retCode |
err_msg | 操作响应消息 | 字段名变更为 errMsg |
标签绑定接口
请求参数变动说明
协议字段 | 字段含义说明 | 信鸽版 | 移动推送 TPNS 版 |
tag_token_list | 当进行标签和设备批量绑定/解绑时,提供需要绑定/解绑的标签设备列表,operator_type =9,10时必填 | 字段格式:[["tag1","token1"],["tag2","token2"]],每个对里面标签在前,token在后, 列表中每个元素为 jsonArray | 字段格式:[{"tag":"tag123", "token":"token123"}],列表中每个元素为 jsonObject |
返回码
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 | 参考 标签接口文档 |