服务端推送接入说明

1.接入必读

该文档主要包含服务器端推送接口定义;

2.准备工作

  1. 在掌趣MIS平台上创建需要接入的产品等信息;
  2. 母包接入BASE SDK时先接好推送接口,这个是前置条件,详见:
    安卓:http://sdk.0708.com/t3/192/3955/1500006317.html 10.推送功能相关
    IOS: http://sdk.0708.com/t3/192/3955/1500006319.html 7.推送功能(使用推送必须添加)

    3.接口说明

参数父节点 参数名称 类型 限制策略 说明
- service 字符串 必填 接口标识,固定为:palm.platfom.push.serverPush
- timestamp 字符串 必填 当前时间的时间戳
- deviceUniqueId 字符串 必填 设备的唯一标识,多个以“,”分隔
- title 字符串 必填 推送标题
- message 字符串 必填 推送的消息,字段长度不能超过4096个字节。
- sound 字符串 可选 是否有提示音,不设置默认为1
0:没有
1:有
- lights 字符串 可选 是否展示3色灯,不设置默认为1
0:不展示
1:展示
设置了该参数也需要看该手机是否支持,不支持则没有效果
- vibrate 字符串 可选 是否震动,不设置默认为1
0:没有
1:有
- isProduction 字符串 可选 是否线上环境,不设置默认为1
0:不是
1:是
- sendTime 字符串 必填 推送时间,格式为:“yyyy-MM-dd HH(24进制):mm:ss”,不填或者比当前时间小,则立即被推送。
- command 字符串 必填 命令
1.打开app应用
2.打开浏览器
3.打开intent
- commandContent 字符串 选填 如果command是2,则该值为url
如果command是3,则该值为intent
- sign 字符串 必填 MD5($service$timestamp$secretKey)
  • 返回参数
参数名称 类型 说明
status 字符串 状态外码 0:失败 1:成功
errorCode 字符串 响应码;00000:接收成功;详见附录响应码表
errorDesc 字符串 描述
  • 请求示例
    1. {
    2. "service": "palm.platfom.push.severPush",
    3. "timestamp":"1507621023822", "deviceUniqueId":"MTAwMDI2OTNAQDAxNkYzMkY1N0UxNkQzNEE5OUE5QTU1NTM2OEU4NEZFQjA=",
    4. "title":"测试",
    5. "message":"测试demo",
    6. "sound":"0",
    7. "lights":"0",
    8. "vibrates":"0",
    9. "isProduction":"0",
    10. "sendTime":"2017-06-09 02:00:00",
    11. "command":"1",
    12. "sign":"e667ea6b417d2d5a7b76e31b93132c16"
    13. }
  • 返回示例
    1. {
    2. "status":"1",
    3. "errorCode":"00000",
    4. "errorDesc":"成功"
    5. }

附录

响应编码表

响应码 描述
00000 成功
10001 单次请求设备数量超限
10002 参数 [ deviceUniqueId ] 不正确
10003 参数 [ timestamp ] 不正确
10004 参数 [ sendTime ] 不正确
10005 参数 [ sendTime ] 格式不正确
10006 参数 [ sign ] 不正确