文档管理中心
我的

此版本文档已归档不再维护,推荐您使用最新版本。

API参考推送服务服务端API(已归档)主题退订API(已归档)

主题退订API

1.接口信息

功能:此接口实现对单个或多个用户的主题退订操作。

约束:每次接口调用最大不超过1000个Token,目前只支持安卓应用。

2.接口原型

承载协议

HTTPS POST

接口方向

应用服务器-> 服务器

接口URL

https://push-api.cloud.huawei.com/v1/[appid]/topic:unsubscribe

3.接口参数

接口请求参数(HTTP header)

展开

参数

取值描述

样例

Authorization

请参考开放平台鉴权章节3.2客户端密码模式。

注意:Bearer后面拼接空格,再拼接获取的access_token。

Bearer CF3Xl2XV6jMKZgqYSZFws9IPlgDvxqOfFSmrlmtkTRupbU2VklvhX9kC9JCnKVSDX2VrDgAPuzvNm3WccUIaDg==

 接口请求参数(HTTP body)

展开

参数值

取值类型

必选(M)/可选(O)

参数说明

topic

string

M

开发者已订阅的主题名称,最大不能超过900个字符,字符只能为数字、字母、下划线、英文点号、英文波浪号、百分号、中文。

tokenArray[]

string

M

开发者已订阅的Token列表,最大不能超过1000个。

样例:["pushtoken1","pushtoken2"]


接口响应参数

展开

参数名称

类型

参数含义

code

string

错误码

msg

string

错误码描述

requestId

string

请求标识

failureCount

integer

失败数量

successCount

integer

成功数量

errors

array

错误列表

index错误token下标

reason错误描述

 

示例请求报文:

  1. {
  2.    "topic": "weather",
  3.    "tokenArray": [
  4.        "pushtoken1",
  5.        "pushtoken2"
  6.    ]
  7. }

示例响应报文:

  1. {
  2.    "msg": "success",
  3.    "code": "80000000",
  4.    "requestId": "157466343107300007000701",
  5.    "successCount": 2,
  6.    "failureCount": 0,
  7.    "errors": []
  8. }

4.接口错误码

HTTP错误码

错误描述

解决措施

200

OK

不涉及

400

参数错误

请检查响应内容错误码并根据错误码进一步排查问题

401

鉴权失败

请检查HTTP头中Authorization参数里面的Access Token

404

找不到服务

请检查请求url是否正确

500

服务内部错误

请联系华为技术支持人员

 

业务错误码

错误描述

解决措施

80000000

成功

不涉及。

80100001

参数检查错误

检查参数

80200001

Oauth认证错误

请求HTTP头中Authorization参数里面的Access Token鉴权失败,请检查。

80200003

Oauth Token过期

请求HTTP头中Authorization参数里面的Access Token已过期,请重新申请后重试。

80400005

数据存储位置未选择

请到AGC上选择应用的数据存储位置。

80400006

数据存储位置与实际不符合

请联系华为技术支持人员解决。

82000007

Topic名称非法

检查topic参数。

82000008

tokenArray为空或者超限

检查tokenArray参数。

82000010

部分Token处理失败

检查失败的token参数。