通知管理服务 API 概述¶
EnOS 通知管理服务 API 为 EnOS 应用提供消息推送和管理能力。应用开发者可以通过调用通知管理服务 API，即时地向用户推送通知短信或邮件，与用户保持互动，从而有效地提高留存率，提升用户体验。关于通知管理服务 API 的完整接口列表及功能说明，参见 API 列表。
前提条件¶
为了对每个应用的消息推送所消耗的资源进行计量，便于业务成本管控，应用开发者需要为应用申请消息推送额度，只有拥有额度的应用，才能正常使用消息推送功能。应用开发者可登录 EnOS 应用门户 > 开发者控制台，选择 通知管理 > 配额，为应用分别分配邮件和短信的额度，并设置超额时是否需要限制推送，以及是否需要告警通知等。
不同 OU 所能使用的短信运营商会依据配置有所不同。目前 EnOS 提供以下运营商选项，如需调整 OU 可用的运营商，可联系系统管理员。
名称 |
ID（tunnelCode） |
应用范围 |
描述 |
|---|---|---|---|
EnOS 中国大陆 |
NOTICE_UMS |
中国大陆 |
对应消息推送服务下的国内短信，待下线，推荐使用 EnOS 系统。 |
EnOS 海外 |
NOTICE_NEXMO |
海外 |
对应消息推送服务下的海外短信，待下线，推荐使用 EnOS 系统。 |
EnOS 系统 |
NOTICE_GW |
全球 |
EnOS 提供的短信运营商，支持往国内与海外发送短信。 |
SCS |
HDB_SCS |
海外 |
HDB 环境需求下对接的指定供应商，仅往海外号码发送短信。 |
Twilio |
TWILIO |
全球 |
DECADA 环境需要对接的指定供应商，可以往国内与海外发送短信，但是国内短信的送达率不能保证 100%。 |
NEXMO |
NEXMO |
海外 |
原短信运营商 nexmo，现已被 vonage 收购，仅往海外号码发送短信。 |
Generic |
GENERIC |
全球 |
通用运营商，可以往国内与海外发送短信。 |
API 列表
¶
你可以通过下表了解可以调用通知管理服务 API 执行哪些操作，每项操作对应的 URL，以及是否适用于 EnOS Cloud 和 EnOS Edge。
操作名称 |
描述 |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|
发送邮件模板 |
√ |
× |
|
发送短信模板 |
√ |
× |
|
查询发送结果 |
√ |
× |
|
查询邮件模板 |
√ |
× |
|
查询短信模板 |
√ |
× |
|
查询邮件地址 |
√ |
× |
|
查询短信签名 |
√ |
× |
|
查询短信渠道 |
√ |
× |
|
发送普通邮件 |
√ |
× |
|
发送普通短信 |
√ |
× |
通用错误码
你可以通过下表查询通知管理服务 API 的通用错误码。有关各 API 特有的错误码，参见 API 文档。
代码 |
错误信息 |
描述 |
|---|---|---|
32400 |
parameter.invalid.app.quota.not.init |
应用未在通知管理服务中配置额度，数据初始化失败。 |
32403 |
permission.denied.tunnel.quota.run.out |
当前渠道额度耗尽，需要等待每日或者每月的额度刷新，或者前往 EnOS 应用门户 > 开发者控制台 调整应用的额度。 |
32600 |
send.message.failed |
消息发送失败。 |
相关链接¶
有关 EnOS 通知管理的更多信息，参见 有关 EnOS 通知管理。
有关如何调用 EnOS API 的更多信息，参见 EnOS API 快速入门。