极光统一消息系统控制台操作指南

为了便于运营人员更好地理解与使用 UMS,本文将详细介绍 UMS 控制台上的各项功能。

首先登陆极光官网,进入服务中心,点击进入统一消息系统

jpush_web

渠道管理

渠道,即消息接入渠道,用于对接开发者的上游消息生产系统或人员,如果开发者拥有多条业务线,每条业务线的消息发送需要单独管理,则建议创建不同的渠道进行区分。

在渠道管理页面,点击「创建渠道」,输入渠道名称,即可创建一个渠道。

jpush_web

点击「渠道设置」,进入渠道信息页面,其中,Channel Key 与 Master Secret 将用于调用 rest API 时的鉴权,请妥善保存防止泄露。

通道管理

通道,即消息下发通道,用于对接 App、微信公众号、微信小程序、短信、邮件、支付宝生活号、钉钉等开发者与用户建立联系的通道。

开发者可以将上述通道所需的鉴权信息配置在 UMS 系统中,再自由组合分配给任意渠道使用,从而实现通道的统一管理。

在通道管理页面,点击「创建通道」,出现通道配置页面,通道信息包含:通道名称、通道编码、通道类型、服务商平台与对应的鉴权信息,说明如下: jpush_web

  • 通道名称:对通道进行命名,全局唯一,要求不超过 30 个字符,支持中英文即特殊字符。
  • 通道编码:通道的绑定标识,全局唯一,将在上传用户信息时用到,仅支持数字和大小写字母,设置后不允许修改。
  • 服务商平台:当某些通道类型下有不同的服务商时,将提供选择,如没有,则该值与通道类型一致。
  • 通道设置:在选择了平台后,将需要输入对应的鉴权信息,各通道类型支持的平台与鉴权信息说明如下
通道类型 平台 鉴权信息 说明
App 极光公有云 AppKey 请填写在极光公有云平台对应创建的应用 Appkey
MasterSecret 请填写在极光公有云平台对应创建的应用 MasterSecret
极光私有云 请求地址 请填写极光私有云系统 REST API 的请求地址,若请求地址中的端口不是 80、443、25、465 这 4 个之一,需要联系商务说明端口
AppKey 请填写在极光私有云系统中对应创建的应用 Appkey
MasterSecret 请填写在极光私有云系统中对应创建的应用 MasterSecret
微信公众号 微信公众号 AppID 请在“微信公众平台-开发-基本配置”页中获得
AppSecret 请在“微信公众平台-开发-基本配置”页中获得
微信小程序 微信小程序 AppID 请在“微信公众平台-开发-开发设置”页中获得
AppSecret 请在“微信公众平台-开发-开发设置”页中获得
短信 极光短信 AppKey 请填写在极光短信平台对应创建的应用 Appkey
MasterSecret 请填写在极光短信平台对应创建的应用 Mater Secret
邮件 SMTP协议 账号 请填写邮件服务的账号
密码 请填写邮件服务的密码
发件人地址 收信人查看邮件时显示的发件人邮件地址
发信服务器地址 请填写邮件服务的发信地址
发信端口 请填写邮件服务的发信端口,若填写的发信端口不是 80、443、25、465 这 4 个之一,需要联系商务说明端口
加密方式 三种可选:无、SSL/TLS、STARTTLS
支付宝生活号 支付宝生活号 AppID 请在“支付宝生活号平台-首页-右上角”处中获得
PrivateKey 请使用“支付宝开放平台开发助手”生成秘钥,填写应用私钥
钉钉 钉钉 AgentId 请在钉钉开发者后台-应用开发-应用信息中获得
AppKey 请在钉钉开发者后台-应用开发-应用信息中获得
AppSecret 请在钉钉开发者后台-应用开发-应用信息中获得

创建通道成功后,可将该通道授权给特定的渠道,点击「渠道授权」,可对渠道进行授权和取消授权,授权后,该渠道将可以给该通道下发消息。 jpush_web

授权成功后,该通道将在该渠道的「渠道设置」-「通道设置」页面中出现,为防止信息泄露,该页面仅展示通道名称、通道编码和平台配置,鉴权信息不会展示。 jpush_web

用户管理

用户,即企业通过各个通道获取到的注册用户,UMS 将帮助企业构建一套统一管理的用户体系。

UMS 采用 userID 作为用户唯一标识,该 Key 的值由企业自行定义,可以将当前业务系统中已设定好的用户编码赋值给 userID,也可以另行设定。

  • 一般来说,企业会对注册用户生成一个唯一标识,该用户产生的所有信息都将与该标识进行绑定,如果没有,则企业也可以借此机会,对用户信息做一次整合。

在用户管理页面,点击「导入用户」,支持以 Excel 和 CSV 格式文件上传用户信息,一次最大支持 5 万条数据,文档大小不超过 30 M,导入数据的格式要求可以参考示例模板。 jpush_web

在导入 userID 与各个通道的对应关系时,有一个重要的关键字段是 bind_id(绑定标识),它可以取值 all、通道编码、渠道 Key

  • all 即全局设置,所有渠道、通道通用,对标签、手机号码、邮箱地址、钉钉 ID 有效,注意:钉钉 ID 的关联标识仅允许传 all
  • 具体的 ChannelKey,在渠道信息中可获取到该值,对标签、手机号码、邮箱地址有效,如果需要设置某一渠道的专属信息,则可以用 Channel Key 做标识,如不需要,则传 all
  • 具体的通道编码,在通道详情中可获取到该值(在创建通道时由运营人员自行设定),在为userID 绑定 App 注册 ID、微信公众号 ID、微信小程序 ID、支付宝生活号 ID 时必须指定通道编码

除了页面导入外,UMS 还提供 REST API 导入用户信息,API 将在后续陆续开放。

API 上传用户信息有两种鉴权方式:

  • 渠道 key 和秘钥鉴权
    • 仅支持上传/修改绑定标识为:该渠道的 ChannelKey、 all 、已授权通道的编码的信息。
  • 全局 key 和秘钥鉴权,该信息在用户管理页面的页尾可以取得。
    • 支持上传所有通道、渠道的用户信息
    • 支持删除用户

注:使用 UMS 系统发送消息,上传用户信息的操作不是必要的,在发送时传递相应通道的 ID 信息即可,但如果想要使用发送策略进行补发,则提前上传用户信息就是必要的,只有通过用户 ID 的发送,发送策略才生效。

通道设置

点击渠道设置-通道设置,可以启用或关闭已授权给该渠道的通道。

通道授权后默认为启用状态。关闭通道将会产生以下影响:

  • 含有本通道的发送策略将变为无效状态
  • 发送消息时将无法选择该通道

而重新启用通道会让含有本通道的无效发送策略变为正常可用状态

发送策略

点击渠道设置-发送策略,可以为该渠道创建不同的发送策略,在发送时指定即可让消息按指定策略进行下发。 jpush_web

发送策略的主要逻辑是:在一定时间内,如果消息在上一步的通道中未送达/未点击,则执行下一步。

jpush_web

  • 发送步骤中,每一个通道仅允许选择 1 次
  • 发送策略必须设置 2 步,如果仅需要并发,则无需创建发送策略
  • 从第 2 步开始,设置下发条件的作用是:当上一步触发条件时,执行本步骤
  • 因回执具有一定的延迟性,因此下发条件支持设置的最小时间长度为 5 分钟

发送策略设置与实际发送时的效果举例说明: jpush_web

发送条件中的 AND、OR 关系说明:

  • AND:所有条件均触发才执行下一步。例如:【APP 在 5 分钟内未完成送达】AND【微信公众号 在 10 分钟内未完成点击】时发送短信,那么若 App 在 5 分钟内送达了,就不会再发送短信
  • OR:任意条件触发就执行下一步,反过来说即所有条件都没有触发才不执行。例如:【APP 在 5 分钟内未完成送达】OR【微信公众号 在 10 分钟内未完成点击】时发送短信,那么即便 App 在 5 分钟内送达了,但微信公众号在 10 分钟内未点击,也将发送短信。

各通道是否支持检测送达与点击状态,以及相关配置要求说明如下:

通道类型 消息状态 是否支持 说明
App 送达 1、检测实际送达到手机的状态。
2、需要将 UMS 的回调地址:https://ums-callback.jiguang.cn/v1/app/callback 配置到极光公有云、私有云的送达回调设置中去。
点击 1、检测实际点击了通知栏消息的状态。
2、需要将 UMS 的回调地址:https://ums-callback.jiguang.cn/v1/app/callback 配置到极光公有云、私有云的点击回调设置中去。
微信公众号 送达 请在“微信公众平台-开发-基本配置”页中设置服务器地址 https://ums-callback.jiguang.cn/v1/wechatoa/callback
点击 1、当配置了跳转链接时,支持检测。
2、配置跳转小程序时不支持检测。
微信小程序 送达 仅支持检测发送至小程序服务器是否成功,无法检测是否实际送达用户
点击 小程序不支持检测点击状态
短信 送达 1、检测短信的实际送达状态
2、请在极光短信-短信设置-回调设置-发送状态回调中,配置 UMS 回调地址 https://ums-callback.jiguang.cn/v1/sms/callback
点击 当短信内容中含有 url 变量,并且传递了跳转链接时支持检测
邮件 送达 当收信服务器返回了成功接收指令时即为送达
点击 无需配置
支付宝生活号 送达 仅支持检测发送至支付宝生活号服务器是否成功,无法检测是否实际送达用户
点击 支付宝生活号的模板消息必须填写跳转链接,因此均支持检测点击状态
钉钉 送达 支持检测真实送达,无需配置
点击 当前仅对卡片消息支持点击

模板管理

点击渠道管理-功能模块-模板,即可进入模板管理页面。当前支持对 App 创建模板,创建与导入第三方平台的模板,如微信公众号/小程序、支付宝生活号、极光短信等的模板。

App 模板

UMS 支持在发消息前创建 App 模板,App 消息中的内容均可以嵌入变量,格式为{{var}},创建成功后,在使用 App 模板发送消息时,仅需要对变量赋值即可。方便企业对消息格式进行管控。 jpush_web jpush_web

微信公众号

微信公众号的模板需要前往微信公众平台-模板消息页面添加或创建。然后在 UMS 微信公众号模板页面,点击刷新即可获取到已添加的模板信息。

当在微信公众平台删除模板后,为了避免该操作为误操作,UMS 对应存储的模板不会直接删除,仅将模板状态变为失效,如企业确认该模板不再使用,则可以在 UMS 页面上点击删除,清除存储的信息。

  • 注:在本页面上点击删除并不会导致微信公众平台的模板被删除。

jpush_web

微信小程序

微信小程序的模板操作上与公众号的模板一致,需要前往微信公众平台-模板消息页面添加或创建,并点击刷新即可获取到列表。

jpush_web

短信

UMS 默认对接支持极光短信,短信模板的管理分为「正文模板管理」与「签名管理」,发送时将签名与正文模版进行组合,最终显示短信=签名+正文。使用极光短信需要先完成实名认证

1、短信模板分为「验证码」「通知」「营销」三种类型,创建时需要选择类型

jpush_web

创建完成后需要等待审核,一般预计三小时内完成审核。审核工作时间:周一至周五,9:00~11:30,13:00~18:00(法定节日顺延)。

  • 审核状态会显示在列表中,需手动点击刷新获取最新的审核状态。
  • 未通过的模板允许编辑,已通过和审核中的模板不允许编辑
  • 点击删除即代表删除极光短信平台的模板
  • 模板状态有三种:正常、失效、未知。
    • 刷新能正常查询到模板,即为正常。
    • 如果在极光短信平台删除了模板,点击刷新则模板状态会变更为无效
    • 创建成功后,若该渠道的短信通道被取消授权、或者换了一个短信通道时,状态将显示为未知。此时若确认取消授权、更换通道的操作无误,可删除这些模板,如为误操作,则可以重新授权,那么刷新模板状态后仍可继续使用这些模板。

jpush_web

2、短信签名需要先在极光短信平台-签名管理页面申请签名,然后将审核通过的签名 ID 导入 UMS 系统中。未来会支持直接在 UMS 系统中创建签名。 jpush_web

签名状态也有三种:正常、失效、未知。

  • 刷新能正常查询到签名,即为正常。
  • 如果在极光短信平台删除了签名,点击刷新则签名状态会变更为无效
  • 创建成功后,若该渠道的短信通道被取消授权、或者换了一个短信通道时,状态将显示为未知。此时若确认取消授权、更换通道的操作无误,可删除这些签名,如为误操作,则可以重新授权,那么刷新签名状态后仍可继续使用这些签名。

支付宝生活号

支付宝生活号的模板需要登陆生活号后台,在模板消息页面申请。申请后点击模板详情,整段复制「模板ID」「模板名称」「关键字段」,粘贴至 UMS。 jpush_web jpush_web

因支付宝未提供查询获取模板列表信息的 API,因此在支付宝平台删除模板后,UMS 无法检测到状态改变,只有当 UMS 在使用该模板推送消息时,若支付宝平台反馈模板不存在,才会将该模板状态变为无效。

消息管理

在渠道管理页面点击推送,进入消息管理页面,在本模块下,可以进行消息发送,查看历史记录和定时任务。

消息推送

在本页面,运营人员可以自由选择进行单通道、多通道的消息发送,也可以创建定时任务。

消息发送分为如下几步:选择推送通道→设置发送时间(即时、定时)→设置推送目标(广播、标签、用户ID、自定义传递通道ID)→选择发送策略(同时发送,自定义策略)→填写各通道的消息内容。

jpush_web

推送历史

推送历史会展示每一条消息在各个通道的目标、送达、点击数据。支持对发送时间、请求方式、通道、目标进行筛选,支持对消息内容、msgid、tag 等进行搜索。

如果该渠道未被授权某一类通道,则推送历史中将不会展示该通道的数据。 jpush_web

定时消息

创建的定时任务将在此展示,可以对预定发送时间、通道、目标进行筛选,也可以对定时消息进行编辑、转发和删除。

jpush_web

统计分析

当前提供推送统计报表分析,汇总多通道的推送数据,可以导出详细列表

jpush_web


Copyright 2011-2020, jiguang.cn, All Rights Reserved.
粤ICP备12056275号-13 深圳市和讯华谷信息技术有限公司

Documentation built with MkDocs.