消息推送服务API概述¶
消息推送服务提供 API 给平台应用后端或移动端调用。
有关 EnOS™ 消息推送管理的详细信息,参见 有关消息推送管理。
有关 EnOS™ API 和 EnOS™ 提供的接口详细信息,参见 有关 EnOS™ API。
有关如何调用 EnOS™ API 的信息,参见 EnOS™ API 快速入门。
前提条件¶
由于消息推送需要计量各服务及应用的消息发送情况,并进行额度控制,默认应用的额度为0,因此某一个应用需要使用本服务,OU 管理员需登录 EnOS 管理控制台,在 EnOS 管理控制台中选择 消息推送管理 > 配额,选择指定应用,申请各个发送通道的额度,并由系统管理员审批通过后才能正常使用。
运营商配置¶
运营商配置说明¶
国内外发送短信到达率可保证的前提是:在选择供应商时需额外注意,运营人员需要将后端对接供应商提供的 API 整合到消息推送服务中,后续如有新增供应商,需要联系产品经理。
当前已对接的运营商¶
不同环境所能使用的运营商会依据配置有所不同。OU 管理员需登录 EnOS 管理控制台,在 EnOS 管理控制台中选择 消息推送管理 > 配额,选择对应应用查看,同时需要申请额度,由系统管理员审批通过后才能使用。
名称 |
tunnelCode |
/ |
描述 |
---|---|---|---|
远景国内 |
NOTICE_UMS |
国内 |
对应 notice 服务下的国内短信 |
远景海外 |
NOTICE_NEXMO |
海外 |
对应 notice 服务下的海外短信 |
SCS |
HDB_SCS |
海外 |
HDB 环境需求下对接的指定供应商,仅往海外号码发送短信 |
Twilio |
TWILIO |
国内/海外 |
DECADA 环境需要对接的指定供应商,可以往国内与海外发送短信,但是国内短信的送达率不能保证100% |
NEXMO |
NEXMO |
海外 |
原短信运营商 nexmo,现已被vonage收购 |
API列表¶
操作名称 |
描述 |
适用于 EnOS Cloud |
适用于 EnOS Edge |
---|---|---|---|
发送模板邮件 |
√ |
× |
|
发送模板短信 |
√ |
× |
|
查询发送结果 |
√ |
× |
通用错误码 ¶
代码 |
错误信息 |
描述 |
---|---|---|
32400 |
parameter.invalid.app.quota.not.init |
服务未在notification服务中进行配置,数据初始化失败 |
32403 |
permission.denied.tunnel.quota.run.out |
渠道额度耗尽,需要等待每日或者每月的额度刷新,或者向系统管理员提交修改额度的申请 |
32600 |
send.message.failed |
消息发送失败 |