Notification Management API Overview¶
EnOS Notification Management Service APIs provide message push and management capabilities for EnOS applications. Application developers can call the Notification Management Service API to instantly push notification SMS or emails to users, interact with users, and thereby effectively improve user retention and enhance user experience. For a complete list of interfaces and functional descriptions of Notification Management APIs, see API List.
Prerequisites¶
To measure the resources consumed by notification for each application, and to facilitate business cost control, application developers need to apply for message push quotas for their applications. Only applications with quotas can use the notification function normally. Application developers can log in to EnOS Application Portal > Developer Console, select Notification Management > Quota, allocate quotas for email and SMS separately for the application, and set whether to restrict push when exceeding the quota, and whether to send alert notifications, etc.
The SMS operators that different OUs can use may vary depending on the configuration. EnOS provides the following operator options. If you need to adjust the available operators for an OU, you can contact the system administrator.
Name |
ID(tunnelCode) |
Scope of Application |
Description |
|---|---|---|---|
EnOS China |
NOTICE_UMS |
China only |
The supplier that can send SMS to China number only, to be deprecated. It is recommended to use EnOS System. |
EnOS Global |
NOTICE_NEXMO |
Global |
The supplier that can send SMS to the number worldwide except China, to be deprecated. It is recommended to use EnOS System. |
EnOS System |
NOTICE_GW |
Global |
The supplier of EnOS that can send SMS to the number worldwide. |
SCS |
HDB_SCS |
Global |
The designated supplier under the HDB environment requirement that can send SMS to the number worldwide except China. |
Twilio |
TWILIO |
Global |
Designated suppliers that need to be connected with DECADA environment can send SMS messages worldwide, but the delivery rate of SMS in China cannot be guaranteed to be 100%. |
NEXMO |
NEXMO |
Global |
Nexmo, the original SMS provider, has been acquired by Vonage, that can send SMS to the number worldwide except China. |
Generic |
GENERIC |
Global |
General supplier that can send SMS messages worldwide. |
API List
¶
You can see what operations can be used via these APIs, the URL corresponding to each operation, and whether it is applicable to EnOS Cloud and EnOS Edge in the following table.
API Name |
Description |
Available on EnOS Cloud |
Available on EnOS Edge |
|---|---|---|---|
Send emails based on the email template. |
√ |
× |
|
Send SMS messages based on the SMS template. |
√ |
× |
|
Search send results. |
√ |
× |
|
Search Email templates. |
√ |
× |
|
Search SMS templates. |
√ |
× |
|
Search Email addresses. |
√ |
× |
|
Search SMS signatures. |
√ |
× |
|
Search SMS channels. |
√ |
× |
Common Error Codes
Code |
Error Log |
Description |
|---|---|---|
32400 |
parameter.invalid.app.quota.not.init |
The service is not configured in the Notification service and data initialization failed. |
32403 |
permission.denied.tunnel.quota.run.out |
The channel quota is exhausted and needs to wait for a daily or monthly quota refresh, or modify the quota for the application in EnOS Application Portal > Developer Console. |
32600 |
send.message.failed |
Message sending failed. |