Notification Management API Overview¶
The Notification Management service provides APIs for invocations by back-end platform applications or mobile applications.
For more information about EnOS Notification Management, see About Notification Management.
For more information about EnOS APIs, see About EnOS API.
To learn how to call an EnOS API, see Getting Started with EnOS API.
Prerequisites¶
The push messaging service measures the sending of messages and controls the quota of each service and application. As the default application quota is 0, if an application needs to use the service, the OU administrator needs to log in to the EnOS Management Console, go to Notification Management > Quota, select the application, and apply for the quota for each send channel. The system administrator needs to approve the quota application before the service can be used.
SMS Service Provider Configuration¶
The premise for ensuring the arrival rate of sending short messages at home and abroad is that extra attention should be paid when selecting suppliers as the back-end needs to connect the APIs provided by the suppliers for the operation personnel to integrate into the notification service. If there are new suppliers in the future, the system administrator needs to be contacted.
Service Providers¶
The providers available in different environments will vary depending on the configuration. The OU administrator needs to log in to the EnOS Management Console, select Notification Management > Quota, and select the corresponding application to check. At the same time, the quota needs to be applied, which can only be used after it is approved by 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¶
| API Name | Description | Available on EnOS Cloud | Available on EnOS Edge |
|---|---|---|---|
| Send Template Mail | Send Email templates. | √ | × |
| Send Template SMS | Send SMS templates. | √ | × |
| Search Send Result | Search send results. | √ | × |
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 submit an application to the system administrator to modify the quota. |
| 32600 | send.message.failed | Message sending failed. |