移动应用推送服务

更新时间：2018-08-25 17:38:12

移动推送是帮助App快速集成移动推送的功能，在实现高效、精确、实时的移动推送的同时，极大地降低了开发成本。

1.验证IOS APP证书和密码

定义描述

path 版本 描述 是否需要用户身份的鉴权
/message/notice/cert/validate 1.1.0 验证IOS APP证书和密码 是，客户端SDK需启用身份的鉴权

请求参数

字段名 子键 类型 是否必填 备注
requestDTO ​ ​Map ​ ​
​ isDevCert Boolean 是 是否开发证书
​ appKey Long 是 appKey
​ certPass String 是 证书密码

返回参数

参数 类型 必有 描述
certType String 是 证书类型
generateDate Date 是 产生时间
appName String 是 应用名称
devCert boolean 是 是否开发证书
expirationDate Date 是 过期时间

示例

请求实例
{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.0"
    },
    "params": {
        "requestDTO": {
            "appKey": 1234,
            "certPass": "0",
            "isDevCert": true
        }
    }
}
返回实例
{
    "code": 200,
    "data": {
        "certType": "X.509",
        "generateDate": 1511166811000,
        "appName": "com.aliyun.iot",
        "devCert": true,
        "expirationDate": 1542702811000
    },
    "id": "200557da-2f97-4db9-90be-b72f69757de0"
}

错误码

错误码 错误信息 来源 描述
200 success 系统 成功
400 request error 系统 请求错误
401 request auth error 系统 请求认证错误
403 request forbidden 系统 请求被禁止
404 service not found 系统 服务未找到
429 too many requests 系统 太多请求
460 request parameter error 系统 请求参数错误
500 service error 系统 服务端错误
503 service not available 系统 服务端错误
4100 APNsWrongCertOrPass 自定义 证书格式不正确或者密码错误

2.获取IOS APP配置

定义描述

path 版本 描述 是否需要用户身份的鉴权
/message/notice/config/ios/get 1.1.0 获取IOS APP配置 是，客户端SDK需启用身份的鉴权

请求参数

字段名 子键 类型 是否必填 备注
requestDTO Map
​appKey Long ​是 ​appKey

返回参数

参数 类型 必有 描述
productCertKey String 是 生产证书
productCertPass Date 否 生产证书密码
devCertKey String 是 开发证书
devCertPass boolean 否 开发证书密码

示例

请求实例
{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.0"
    },
    "params": {
        "requestDTO": {
            "appKey": 1234
        }
    }
}
返回实例
{
    "code": 200,
    "data": {
        "devCertKey": "devkey",
        "productCertKey": "prodkey"
    },
    "message": "success"
}

错误码

错误码 错误信息 来源 描述
200 success 系统 成功
400 request error 系统 请求错误
401 request auth error 系统 请求认证错误
403 request forbidden 系统 请求被禁止
404 service not found 系统 服务未找到
429 too many requests 系统 太多请求
460 request parameter error 系统 请求参数错误
500 service error 系统 服务端错误
503 service not available 系统 服务端错误

3.获取移动设备信息</span>

定义描述

path 版本 描述 是否需要用户身份的鉴权
/message/notice/device/get 1.1.0 获取移动设备信息 是，客户端SDK需启用身份的鉴权

请求参数

字段名 子键 类型 是否必填 备注
requestDTO ​ ​Map ​ ​
​ ​appKey Long ​是 ​appKey
deviceId String 是 设备ID

返回参数

参数 类型 必有 描述
deviceInfo JSON 是 设备信息

示例

请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.0"
    },
    "params": {
        "requestDTO": {
            "appKey": 1234,
            "deviceId": "XXXX"
        }
    }
}

返回实例

{
    "code": 200,
    "data": {
        "deviceInfo": {
            "account": "",
            "alias": "",
            "deviceId": "b729a6dc51e14e99936a68d707906cff",
            "deviceToken": "20c9618f042658031ee7c5b84abb0e4b072359d905b1eb1511e21af9675fbebf",
            "deviceType": "iOS",
            "lastOnlineTime": "2017-12-14T13:11:44Z",
            "online": false,
            "tags": "htp_test_tag"
        }
    },
    "message": "success"
}

错误码

错误码 错误信息 来源 描述
200 success 系统 成功
400 request error 系统 请求错误
401 request auth error 系统 请求认证错误
403 request forbidden 系统 请求被禁止
404 service not found 系统 服务未找到
429 too many requests 系统 太多请求
460 request parameter error 系统 请求参数错误
500 service error 系统 服务端错误
503 service not available 系统 服务端错误
4104 InvalidDeviceId 自定义 无效的DeviceId

4.获取推送记录详细信息

定义描述

path
版本
描述
是否需要用户身份的鉴权
/message/notice/record/get
1.1.0
获取推送记录详细信息
是，客户端SDK需启用身份的鉴权

请求参数

字段名 子键 类型 是否必填 备注
requestDTO ​ ​Map ​ ​
​ ​appKey Long ​是 ​appKey
​ messageId String 是 消息ID

返回参数

参数 类型 必有 描述
deviceType String 是 设备类型
target String 是 发送对象类型
targetValue String 是 发送对象
messageId String 是 消息ID
type String 是 消息类型
body String 是 消息体
pushTime Date 是 推送时间
title String 是 消息标题
status String 是 推送状态

示例

请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.0"
    },
    "params": {
        "requestDTO": {
            "appKey": 1234,
            "messageId": "XXXX"
        }
    }
}

返回实例

{
    "code": 200,
    "data": {
        "deviceType": "iOS",
        "targetValue": "509dop2d18644f77a4b0787c5d032be5e0135138",
        "messageId": "500178",
        "type": "MESSAGE",
        "body": "body2",
        "pushTime": "2018-03-15T11:51:45Z",
        "title": "title2",
        "target": "ACCOUNT",
        "status": "SENT"
    },
    "id": "c45a4aa9-df2f-4279-8320-e2242109aed7"
}

错误码

错误码 错误信息 来源 描述
200 success 系统 成功
400 request error 系统 请求错误
401 request auth error 系统 请求认证错误
403 request forbidden 系统 请求被禁止
404 service not found 系统 服务未找到
429 too many requests 系统 太多请求
460 request parameter error 系统 请求参数错误
500 service error 系统 服务端错误
503 service not available 系统 服务端错误

5.修改Android APP配置

定义描述

path
版本
描述
是否需要用户身份的鉴权
/message/notice/config/android/modify
1.1.0
修改Android APP配置
是，客户端SDK需启用身份的鉴权

请求参数

字段名 子键 类型 是否必填 备注
requestDTO Map
appKey Long 是 appKey
gcmToken String 否 google GCM token
xmAppSecretKey S​tring 否 小米secret
hwAppKey S​tring 否 华为appKey
hwAppSecretKey String 否 华为secret

返回参数

参数 类型 必有 描述
data String 是 修改结果

示例

请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.0"
    },
    "params": {
        "requestDTO": {
            "gcmToken": "X1",
            "xmAppSecretKey": "X2",
            "hwAppKey": "X3",
            "hwAppSecretKey": "X4"
        }
    }
}

返回实例

{
    "code": 200,
    "data": "",
    "id": "4212fe53-21a6-4734-8417-5cf5b54f4db5"
}

错误码

错误码 错误信息 来源 描述
200 success 系统 成功
400 request error 系统 请求错误
401 request auth error 系统 请求认证错误
403 request forbidden 系统 请求被禁止
404 service not found 系统 服务未找到
429 too many requests 系统 太多请求
460 request parameter error 系统 请求参数错误
500 service error 系统 服务端错误
503 service not available 系统 服务端错误

6.开启APP推送配置

定义描述

path 版本 描述 是否需要用户身份的鉴权
/message/notice/config/modify 1.1.0 开启APP推送配置 是，客户端SDK需启用身份的鉴权

请求参数

字段名 子键 类型 是否必填 备注
requestDTO ​ Map ​ ​
​ appKey Long 是 appKey
​ packageName String 是 包名

返回参数

参数 类型 必有 描述
data String 是 修改结果

示例

请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.0"
    },
    "params": {
        "requestDTO": {
            "appKey": 1234,
            "packageName": "test.aliyun.com"
        }
    }
}

返回实例

{
    "code": 200,
    "data": "",
    "id": "be48655b-c4cc-45f1-b48a-42b66aa2791b"
}

错误码

错误码 错误信息 来源 描述
200 success 系统 成功
400 request error 系统 请求错误
401 request auth error 系统 请求认证错误
403 request forbidden 系统 请求被禁止
404 service not found 系统 服务未找到
429 too many requests 系统 太多请求
460 request parameter error 系统 请求参数错误
500 service error 系统 服务端错误
503 service not available 系统 服务端错误

7.修改IOS APP配置

定义描述

path 版本 描述 是否需要用户身份的鉴权
/message/notice/config/ios/modify 1.1.0 修改IOS APP配置 是，客户端SDK需启用身份的鉴权

请求参数

字段名 子键 类型 是否必填 备注
requestDTO ​ Map ​ ​
​ appKey Long 是 appKey
devCertKey String 是 开发证书
​ devCertPass String 是 开发证书密码
productCertKey String 是 生产证书
productCertPass String 是 生产证书密码

返回参数

参数 类型 必有 描述
data String 是 修改结果

示例

请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.0"
    },
    "params": {
        "requestDTO": {
            "appKey": 1234,
            "devCertKey": "a",
            "devCertPass": "b",
            "productCertKey": "c",
            "productCertPass": "d"
        }
    }
}

返回实例

{
    "code": 200,
    "data":"",
    "message": "success"
}

错误码

错误码 错误信息 来源 描述
200 success 系统 成功
400 request error 系统 请求错误
401 request auth error 系统 请求认证错误
403 request forbidden 系统 请求被禁止
404 service not found 系统 服务未找到
429 too many requests 系统 太多请求
460 request parameter error 系统 请求参数错误
500 service error 系统 服务端错误
503 service not available 系统 服务端错误
4101 APNsInvalidPass 自定义 APNs证书密码不匹配

8.IOS证书试连

定义描述

path 版本 描述 是否需要用户身份的鉴权
/message/notice/cert/preflight 1.1.0 IOS证书试连 是，客户端SDK需启用身份的鉴权

请求参数

字段名 子键 类型 是否必填 备注
requestDTO ​ Map ​ ​
​ appKey Long 是 appKey
​ pass String 是 密码
​ isDevCert String 是 是否开发证书
​ body String 是 消息体
​ deviceToken String 是 设备token

返回参数

参数 类型 必有 描述
data String 是 发送结果

示例

请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.0"
    },
    "params": {
        "requestDTO": {
            "appKey": 1234,
            "body": "body1",
            "deviceToken": "token1234",
            "isDevCert": true,
            "pass": "0"
        }
    }
}

返回实例

{
    "code": 200,
    "data": "",
    "message": "success"
}

错误码

错误码 错误信息 来源 描述
200 success 系统 成功
400 request error 系统 请求错误
401 request auth error 系统 请求认证错误
403 request forbidden 系统 请求被禁止
404 service not found 系统 服务未找到
429 too many requests 系统 太多请求
460 request parameter error 系统 请求参数错误
500 service error 系统 服务端错误
503 service not available 系统 服务端错误

9.推送信息

定义描述

path 版本 描述 是否需要用户身份的鉴权
/message/notice/push 1.1.0 推送信息 是，客户端SDK需启用身份的鉴权

请求参数

字段名
子键
类型
是否必填
备注
requestDTO
Map
androidNotificationBarType
Integer
否
Android自定义通知栏样式，取值：1-100
androidPopupBody
String
否
辅助弹窗模式下Body内容,长度限制:<128字符（中英文都以一个字符计算）。
storeOffline
Boolean
否
离线消息是否保存,若保存, 在推送时候，用户即使不在线，下一次上线时会收到，与ExpireTime参数配合使用。
smsSignName
String
否
补发短信的签名
androidOpenUrl
String
否
Android收到推送后打开对应的url,仅当AndroidOpenType="URL"有效
androidPopupTitle
String
否
辅助弹窗模式下Title内容,长度限制:<16字符（中英文都以一个字符计算）。
title
String
是
使用内容模板则content传入json字符串 key:value替换内容模板的占位符
body
String
是
使用标题模板则传入json字符串 key:value替换tiltle模板的占位符
iOSExtParameters
String
否
通知的扩展属性(注意 : 该参数要以json map的格式传入,否则会解析出错)
iOSBadge
Integer
否
iOS应用图标右上角角标
dbTargetValue
String
否
真*推送目标，入库的推送目标
iOSRemind
Boolean
否
消息推送时设备不在线，则这条推送会做为通知，通过苹果的APNs通道送达一次。注意：离线消息转通知仅适用于生产环境
androidMusic
String
否
Android通知声音
iOSRemindBody
String
否
iOS消息转通知时使用的iOS通知内容，仅当iOSApnsEnv=PRODUCT && iOSRemind为true时有效
androidPopupActivity
String
否
此处指定通知点击后跳转的Activity。
dbTarget
String
否
真*推送目标类型，入库的推送目标类型
androidExtParameters
String
否
设定通知的扩展属性。(注意 : 该参数要以 json map 的格式传入,否则会解析出错)
targetValue
String
是
根据Target来设定，多个值使用逗号分隔，最多支持100个，超过100分多次推送。 `Target=DEVICE` `Target=ACCOUNT` `Target=ALIAS`， `Target=TAG`，支持单Tag和多Tag，格式请参考 [标签格式](//~~48055~~.html) `Target=ALL`，值为`all`
iOSApnsEnv
String
否
iOS的通知是通过APNs中心来发送的，需要填写对应的环境信息。 `DEV`：表示开发环境 `PRODUCT`：表示生产环境
androidNotifyType
String
否
通知的提醒方式 `VIBRATE`：振动 **默认值** `SOUND`：声音 `BOTH`：声音和振动 `NONE`：静音
appKey
Long
是
appKey
pushTime
String
否
用于定时发送。不设置缺省是立即发送。时间格式按照ISO8601标准表示，并需要使用UTC时间，格式为YYYY-MM-DDThh:mm:ssZ。
smsSendPolicy
Integer
否
触发短信的条件：0 推送未收到时触发，1 用户未打开时触发
deviceType
String
是
设备类型，取值范围为： `iOS`：iOS设备 `ANDROID`：Andriod设备 `ALL`：全部类型设备
iOSSilentNotification
Boolean
否
开启iOS静默通知
iOSBadgeAutoIncrement
Boolean
否
是否开启角标自增功能，默认为False，当该项为True时，iOSBadge必须为为空。角标自增功能由推送服务端维护每个设备的角标计数，需要用户使用1.9.5以上版本的sdk，并且需要用户主动同步角标数字到服务端。
iOSMusic
String
否
iOS通知声音
smsParams
String
否
短信模板的变量名值对，格式： key1=value1&key2=value2
smsTemplateName
String
否
补发短信的模板名，可以在短信模板管理界面获取，是系统分配的名称，而非开发者设置的名字
smsDelaySecs
Integer
否
触发短信的延迟时间，秒。推荐设置为 15 秒以上，避免短信和推送的重复
bodyTemplateCode
String
否
内容模板code
iOSNotificationCategory
String
否
指定iOS通知Category（只针对iOS10）
titleTemplateCode
String
否
标题模板code
target
String
是
推送目标： `DEVICE`:根据设备推送 `ACCOUNT`:根据账号推送 `ALIAS`:根据别名推送 `TAG`:根据标签推送 `ALL`:推送给全部设备
pushType
String
是
`MESSAGE`：表示消息，**默认值** * `NOTICE`：表示通知
iOSMutableContent
Boolean
否
允许扩展iOS通知内容，比如富媒体信息传递（只针对iOS10）
androidNotificationBarPriority
Integer
否
Android通知在通知栏展示时排列位置的优先级 -2 -1 0 1 2
expireTime
String
否
离线消息的过期时间，过期则不会再被发送。离线消息最长保存72小时，过期时间时长不会超过发送时间加72小时。时间格式按照ISO8601标准表示，并需要使用UTC时间，格式为YYYY-MM-DDThh:mm:ssZ。
iOSSubtitle
String
否
iOS通知副标题内容（只针对iOS10）
androidOpenType
String
否
点击通知后动作 `APPLICATION`：打开应用 **默认值** `ACTIVITY`：打开应用AndroidActivity `URL`：打开URL `NONE`：无跳转
androidActivity
String
否
设定通知打开的activity，仅当AndroidOpenType="Activity"有效
androidRemind
Boolean
否
推送类型为消息时设备不在线，则这条推送会使用辅助弹窗功能。默认值为False，仅当PushType=MESSAGE时生效。

返回参数

参数 类型 必有 描述
messageId String 是 消息ID

示例

请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.0"
    },
    "params": {
        "requestDTO": {
            "appKey": 1234,
            "body": "body2",
            "deviceType": "iOS",
            "pushType": "MESSAGE",
            "target": "ACCOUNT",
            "targetValue": "509dop2d18644f77a4b0787c5d032be5e0135138",
            "title": "title2"
        }
    }
}

返回实例

{
    "code": 200,
    "data": {
        "messageId": "500179"
    },
    "id": "a60c092f-cd93-42cf-b289-fb6ed9c80273"
}

错误码

错误码 错误信息 来源 描述
200 success 系统 成功
400 request error 系统 请求错误
401 request auth error 系统 请求认证错误
403 request forbidden 系统 请求被禁止
404 service not found 系统 服务未找到
429 too many requests 系统 太多请求
460 request parameter error 系统 请求参数错误
500 service error 系统 服务端错误
503 service not available 系统 服务端错误

10.查询设备别名

定义描述

path 版本 描述 是否需要用户身份的鉴权
/message/notice/alias/query 1.1.0 查询设备别名 是，客户端SDK需启用身份的鉴权

请求参数

字段名 子键 类型 是否必填 备注
requestDTO ​ Map ​ ​
​ appKey Long 是 ​appKey
deviceId String 是 设备ID

返回参数

字段​ 类型​ 必有 描述
data List 是 ​别名列表

示例

请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.0"
    },
    "params": {
        "requestDTO": {
            "appKey": 1234,
            "deviceId": "deviceId1"
        }
    }
}

返回实例

{
    "code": 200,
    "data": [
        "alias1"
    ],
    "id": "4212fe53-21a6-4734-8417-5cf5b54f4db5"
}

错误码

错误码 错误信息 来源 描述
200 success 系统 成功
400 request error 系统 请求错误
401 request auth error 系统 请求认证错误
403 request forbidden 系统 请求被禁止
404 service not found 系统 服务未找到
429 too many requests 系统 太多请求
460 request parameter error 系统 请求参数错误
500 service error 系统 服务端错误
503 service not available 系统 服务端错误

11.查询Android APP配置

定义描述

path 版本 描述 是否需要用户身份的鉴权
/message/notice/config/android/query 1.1.0 查询Android APP配置 是，客户端SDK需启用身份的鉴权

请求参数

字段名 子键 类型 是否必填 备注
requestDTO Map
appKey Long 是 appKey

返回参数

字段​ 类型​ 必有 描述
h​wAppKey String 是 华为appKey
h​wAppSecretKey String 是 华为secret
x​mAppSecretKey String 是 小米secret
g​cmToken String 是 google token

示例

请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.0"
    },
    "params": {
        "requestDTO": {
            "appKey": 1234
    }
}

返回实例

{
    "code": 200,
    "data": {
        "hwAppKey": "11",
        "hwAppSecretKey": "22",
        "xmAppSecretKey": "33",
        "gcmToken": "44"
    },
    "id": "8c0963f1-f7ef-4d23-b7c8-cad28011abbd"
}

错误码

错误码 错误信息 来源 描述
200 success 系统 成功
400 request error 系统 请求错误
401 request auth error 系统 请求认证错误
403 request forbidden 系统 请求被禁止
404 service not found 系统 服务未找到
429 too many requests 系统 太多请求
460 request parameter error 系统 请求参数错误
500 service error 系统 服务端错误
503 service not available 系统 服务端错误

12.查询APP配置状态

定义描述

path 版本 描述 是否需要用户身份的鉴权
/message/notice/config/status 1.1.0 查询APP配置状态 是，客户端SDK需启用身份的鉴权

请求参数

字段名 子键 类型 是否必填 备注
requestDTO ​ Map ​ ​
​ appKeys List 是 appKey 列表

返回参数

字段​ 类型​ 必有 描述
appKey String 是 appKey
enableAppPush Boolean 是 是否可以推送消息

示例

请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.0"
    },
    "params": {
        "requestDTO": {
            "appKeys": [1234]
        }
    }
}

返回实例

{
    "code": 200,
    "data": [
        {
            "appKey": 24700964,
            "enableAppPush": true
        }
    ],
    "id": "aa1b8f2a-5447-4e07-82f5-b4041abd0587"
}

错误码

错误码 错误信息 来源 描述
200 success 系统 成功
400 request error 系统 请求错误
401 request auth error 系统 请求认证错误
403 request forbidden 系统 请求被禁止
404 service not found 系统 服务未找到
429 too many requests 系统 太多请求
460 request parameter error 系统 请求参数错误
500 service error 系统 服务端错误
503 service not available 系统 服务端错误

13.查询推送记录

定义描述

path
版本
描述
是否需要用户身份的鉴权
/message/notice/record/query
1.1.0
查询推送记录
是，客户端SDK需启用身份的鉴权

请求参数

字段名 子键 类型 是否必填 备注
requestDTO ​ Map ​ ​
targetValue 是 appKey 列表
page 是 起始页
pageSize 是 页大小
startTime 否 开始时间
endTime 否 结束时间
appKey 是 appKey
pushType 否 推送类型
target 否 接收方类型

返回参数

字段​ 子键 类型​ 必有 描述
messageInfos List 是
deviceType String 是 设备类型
targetValue String 是 推送目标
messageId String 是 消息ID
type String 是 消息类型
body String 是 消息体
pushTime Date​ 是 推送时间
target String​ 是 目标类型
status String​ 是 发送状态

示例

请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.0"
    },
    "params": {
        "requestDTO": {
            "appKey": 1234,
            "endTime": "2018-04-01 00:00:00",
            "startTime": "2018-01-01 00:00:00"
        }
    }
}

返回实例

{
    "code": 200,
    "data": {
        "messageInfos": [
            {
                "deviceType": "iOS",
                "targetValue": "509dop2d18644f77a4b0787c5d032be5e0135138",
                "messageId": "500178",
                "type": "MESSAGE",
                "body": "body2",
                "pushTime": "2018-03-15T11:51:45Z",
                "title": "title2",
                "target": "ACCOUNT",
                "status": "SENT"
            }
        ],
        "total": 1,
        "pageSize": 100,
        "page": 1
    },
    "id": "9f5266fb-c22c-47aa-9203-d037e7368990"
}

错误码

错误码 错误信息 来源 描述
200 success 系统 成功
400 request error 系统 请求错误
401 request auth error 系统 请求认证错误
403 request forbidden 系统 请求被禁止
404 service not found 系统 服务未找到
429 too many requests 系统 太多请求
460 request parameter error 系统 请求参数错误
500 service error 系统 服务端错误
503 service not available 系统 服务端错误

14.获取标签列表

定义描述

path 版本 描述 是否需要用户身份的鉴权
/message/notice/tag/query 1.1.0 获取标签列表 是，客户端SDK需启用身份的鉴权

请求参数

字段名 子键 类型 是否必填 备注
requestDTO ​ Map ​ ​
​ appKey ​ 是 appKey

返回参数

字段​ 类型​ 必有 描述
data List 是 tag名称列表

示例

请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.0"
    },
    "params": {
        "requestDTO": {
            "appKey": 12345678
        }
    }
}

返回实例

{
    "code": 200,
    "data": [
        "tag1"
    ],
    "id": "720d71dc-0762-4726-bea7-18aca4bbe197"
}

错误码

错误码 错误信息 来源 描述
200 success 系统 成功
400 request error 系统 请求错误
401 request auth error 系统 请求认证错误
403 request forbidden 系统 请求被禁止
404 service not found 系统 服务未找到
429 too many requests 系统 太多请求
460 request parameter error 系统 请求参数错误
500 service error 系统 服务端错误
503 service not available 系统 服务端错误

15.上传IOS APP证书</span>

定义描述

path 版本 描述 是否需要用户身份的鉴权
/message/notice/cert/upload 1.1.0 上传IOS APP证书 是，客户端SDK需启用身份的鉴权

请求参数

字段名 子键 类型 是否必填 备注
requestDTO ​ Map ​ ​
​ appKey ​Long 是 appKey
isDevCert Boolean 是 是否开发证书
fileItem String 是 证书内容

返回参数

字段​ 类型​ 必有 描述
certKey String 是 证书Key

示例

请求实例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.1.0"
    },
    "params": {
        "requestDTO": {
            "appKey": 1234,
            "fileItem": "1234",
            "isDevCert": true
        }
    }
}

返回实例

{
    "code": 200,
    "data": {
        "certKey": "TB1dqUMaTdYBeNkSmLyXXXfnVXa123"
    },
    "id": "360e19db-8735-4f94-b378-4694f4db4f9d"
}

错误码

错误码 错误信息 来源 描述
200 success 系统 成功
400 request error 系统 请求错误
401 request auth error 系统 请求认证错误
403 request forbidden 系统 请求被禁止
404 service not found 系统 服务未找到
429 too many requests 系统 太多请求
460 request parameter error 系统 请求参数错误
500 service error 系统 服务端错误
503 service not available 系统 服务端错误

results matching ""

    No results matching ""