目录

主题订阅

为了更安全的网络访问,华为推送服务于2022年11月30日关闭Push相关域名的TLS1.0、TLS1.1协议及规定之外的加密套件,关闭后,应用使用TLS1.2以下协议或使用规定外的加密套件将无法正常推送消息。

若您的应用访问Push相关域名使用协议是TLS1.0或TLS1.1,后续可能无法正常发送消息,请您务必升级到TLS1.2及以上版本。

调整指导请查阅《Push Kit相关域名的TLS1.0和TLS1.1协议关闭通知》,如您有任何疑问,请联系技术支持,感谢您对华为推送的支持。

功能介绍

此接口实现给单个或多个用户完成主题订阅操作。

接口约束

每次接口调用最大不超过1000个Token,并行发送主题消息数量最大不超过100个,目前只支持Android应用。

接口原型

承载协议

HTTPS POST

接口方向

开发者服务器 -> 华为Push服务器

接口URL

https://push-api.cloud.huawei.com/v1/[clientid]/topic:subscribe

说明:

[clientid]:OAuth2.0客户端ID(凭据),登录AppGallery Connect网站,选择“开发与服务”,在项目列表中选择对应的项目,左侧导航栏选择“项目设置”,在该页面获取。

数据格式

请求消息:Content-Type: application/json;charset=UTF-8

响应消息:Content-Type: application/json

请求参数

Request Header

参数

取值描述

样例

Authorization

通过OAuth 2.0开放鉴权(客户端模式)获取的 Access Token 或者基于服务账号生成的鉴权令牌(JSON Web Token)。

说明:

Bearer后面拼接空格,再拼接获取的 Access Token 或 JSON Web Token。

Bearer CF3Xl2XV6jMK*******ccUIaDg==

或

Bearer eyJr*****OiIx****.eyJh*****iJodHR**.QRod*****4Gp****

Request Body

参数

是否必选

参数类型

描述

topic

是

String

订阅的主题名称,最大不能超过900个字符,支持的字符包括数字、字母、下划线、百分号、中文、英文点号、英文波浪号、英文破折号。

tokenArray

是

Array [String]

订阅的Token列表,最大不能超过1000个。样例:["pushtoken1","pushtoken2"]。

请求示例

{
    "topic": "weather",
    "tokenArray": [
        "pushtoken1",
        "pushtoken2"
    ]
}

响应参数

Response Body

参数

参数类型

描述

code

String

错误码。

msg

String

错误码描述。

requestId

String

请求标识。

failureCount

Integer

失败数量。

successCount

Integer

成功数量。

errors

Array [Object]

错误列表。

  • index:错误Token下标
  • reason:错误描述

响应示例

{
    "msg": "partial token processed fail",
    "code": "82000010",
    "requestId": "1574*******00701",
    "successCount": 1,
    "failureCount": 1,
    "errors": [
        {
            "index": 0,
            "reason": "wrong token format"
        }
    ]
}

错误码

HTTP错误码

描述

解决方法

200

成功。

不涉及。

400

参数错误。

请根据错误码描述进一步排查问题。

401

鉴权失败。

请求HTTP头中Authorization参数鉴权令牌错误。

404

找不到服务。

请检查请求URI是否正确。

500

服务内部错误。

请选择“支持 > 技术支持 > 在线提单”提交问题,技术支持人员会及时处理。

502

请求连接异常,常见于网络状况不稳定。

建议稍后重试,或联系技术支持解决。

503

流量控制。

  1. 平均分配发送速度,尽量控制在华为提供的QPS配额内。QPS配额请查看FAQ。
  2. 平均分布推送时间段,不要集中发送。

业务错误码

描述

解决方法

80000000

成功。

不涉及。

80100001

参数检查错误。

按照响应消息中的提示,请检查请求参数。

80100017

同时发送的Topic消息数量超过100个。

请稍后再发送主题消息,增加主题消息发送间隔。

80200001

认证错误。

请求HTTP头中Authorization参数鉴权令牌错误。

  1. 下发消息未添加Authorization参数或Authorization的值为空。
  2. 通过OAuth 2.0开放鉴权(客户端模式)获取的 Access Token 对应的 Client ID 和推送消息的 Client ID 不一致。比如,应用A的 Client ID 申请的 Access Token,用于给应用B推送消息。
  3. 基于服务账号生成的鉴权令牌(JSON Web Token)解析错误。

80200003

Access Token过期。

请求HTTP头中Authorization参数中通过OAuth 2.0开放鉴权(客户端模式)获取的 Access Token 已过期,请重新申请后重试。

80200005

JSON Web Token 过期

请求HTTP头中Authorization参数中基于服务账号生成的鉴权令牌(JSON Web Token)过期,请重新生成。

80400005

数据处理位置未选择。

请为您的应用设置数据处理位置,详情请参见设置默认数据处理位置。

80400006

数据处理位置与实际不符合。

请联系技术支持。

80400007

没有权限保存用户数据。

请为你的项目开通精准推送能力。

82000007

Topic名称非法。

请检查Topic参数。

82000008

tokenArray为空或者超限。

请检查tokenArray参数。

82000009

Topic数量超限(2000)。

请检查Topic参数。

82000010

部分Token处理失败。

请检查失败的Token。

82000012

Token值不合法。

请检查Token。