Skip to content
This repository has been archived by the owner on Nov 25, 2020. It is now read-only.

参数说明

perky123 edited this page Feb 25, 2016 · 9 revisions

接口类型

  • push_message_to_single 对单个用户推送
  • push_message_to_list 通过 client_id 群推
  • push_messag_to_app 通过 app_id 群推,给所有符合条件的客户端推送

支持推送类型

  • 透传 payload
  • 点击推送启动应用
  • 点击通知打开网页
  • 点击通知下载应用(iOS 不支持)

模板类型

透传模板 TransmissionTemplate

属性 长度 必填 说明
app_id - 设定接收的应用
app_key - 用于鉴定身份是否合法
transmission_type 4 byte 收到消息是否立即启动应用, 1 为立即启动, 0 则广播等待 客户端自启动
transmission_content 2048 中/英字 符 透传内容,不支持转义字符
push_info - 设定接收的应用 设定 iOS APN 通知参数,暂不支持

通知模板 NotificationTemplate

属性 长度 必填 说明
app_id - 设定接收的应用
app_key - 用于鉴定身份是否合法
push_info - 设定接收的应用 设定 iOS APN 通知参数,暂不支持
title 40 中/英字符 通知标题
text 600 中/英字符 通知内容
logo 40 中/英字符 通知的图标名称,包含后缀名(需要在客 户端开发时嵌入), 如 "push.png"
logo_url - 通知图片网址,含后缀,可以使用网络图片当做通知的图标
is_ring - 是否响铃。true 响铃, false 不响铃。默认响铃
is_vibrate - 是否振动。true 振动, false 不振动。默认振动
is_clearable - 是否可清除。true 可清除,false 不可清除。默认可清除

通知链接模 LinkTemplate

除支持 NotificationTemplate 参数外,还支持如下参数

属性 长度 必填 说明
url - 收到通知后打开的网址

通知栏弹框下载模版 NotyPopLoadTemplate

除支持 NotificationTemplate 参数外,还支持如下参数

属性 长度 必填 说明
pop_title 40 中/英字符 弹出框标题
pop_text 600 中/英字符 弹出框内容
pop_image 200 中/英字符 弹出框图标
pop_button_1 4 中/英字符 弹出框左边按钮名称
pop_button_2 4 中/英字符 弹出框右边按钮名称
load_icon 40 中/英字符 下载图标
load_title 40 中/英字符 下载标题
load_url 200 中/英字符 下载地址
android_mask 40 中/英字符 包名,比如:com.sina.weibo
symbia_mask 40 中/英字符 UID,比如:0x27000000
ios_mask 40 中/英字符 URL Schema,用于唤醒对应的 IOS 应用
is_auto_install - 是否自动安装(默认否)
is_active - 安装完成后是否自动启动应 用程序(默认否)

Message 基本参数解释

属性 必填 说明
is_offline 当用户不在线时,是否离线存储,默认值:是
offline_expire_timea 离线有效时间,单位毫秒,默认值:12 小时
data 模板内容

AppMessage 附加参数解释

除支持 Message 基本参数外,AppMessage 还支持如下参数

属性 必填 说明
app_id_list app_id 数组
phone_type_list 通知接收者的手机操作系统类型数组,建议不设置
province_list 省名称数组,此参数为可选参数
tag_list 标签数组,此参数为可选参数