消息推送服务 API 概述


消息推送服务提供 API 给平台应用后端或移动端调用。


有关 EnOS 消息推送管理的详细信息,参见 有关消息推送管理
有关 EnOS API 和 EnOS 提供的接口详细信息,参见 有关 EnOS API
有关如何调用 EnOS API 的信息,参见 EnOS API 快速入门

前提条件


由于消息推送需要计量各服务及应用的消息发送情况,并进行额度控制,默认应用的额度为0,因此某一个应用需要使用本服务,OU 管理员需登录 EnOS 管理控制台,在 EnOS 管理控制台中选择 消息推送管理 > 配额,选择指定应用,申请各个发送通道的额度,并由系统管理员审批通过后才能正常使用。


短信运营商配置


国内外发送短信到达率可保证的前提是:在选择供应商时需额外注意,运营人员需要将后端对接供应商提供的 API 整合到消息推送服务中,后续如有新增供应商,需要联系系统管理员。

可用运营商

不同环境所能使用的运营商会依据配置有所不同。OU 管理员需登录 EnOS 管理控制台,在 EnOS 管理控制台中选择 消息推送管理 > 配额,选择对应应用查看,同时需要申请额度,由系统管理员审批通过后才能使用。

API 列表


操作名称

描述

适用于 EnOS Cloud

适用于 EnOS Edge

Send Template Mail

发送模板邮件

×

Send Template SMS

发送模板短信

×

Search Send Result

查询发送结果

×

Search Mail Template

查询邮件模板

×

Search SMS Template

查询短信模板

×

Search Mail Address

查询邮件地址

×

Search SMS Signature

查询短信签名

×

Search SMS Channel

查询短信渠道

×

Send Regular Mail

发送普通邮件

×

Send Regular SMS

发送普通短信

×

通用错误码


代码

错误信息

描述

32400

parameter.invalid.app.quota.not.init

服务未在消息推送管理服务中进行配置,数据初始化失败

32403

permission.denied.tunnel.quota.run.out

渠道额度耗尽,需要等待每日或者每月的额度刷新,或者向系统管理员提交修改额度的申请

32600

send.message.failed

消息发送失败