Qodex.ai

Notification API

Number of APIs: 35

Notification APIs enables applications to distribute information through various notification channels like E-mail, Push notification and SMS. Application developer/operator may use different APIs to send notifications and get delivery status of notification through their application. It allows developers to manage and utilize the following operations related to notification messages, namely:

  1. Registration of mobile apps and mobile app installation instances for receiving push notifications
  2. Sending push notifications to set of users of a mobile app; addressed either by email address or the mobile app instances.
  3. Sending emails to a set of target recipients or a broadcast group with an option to attach files.
  4. Sending SMS to to a set of target recipients.
Limitations

  • This API cannot be accessed by subtenants.
  • The service may decide to throttle API requests temporarily returning a 429 status code.

Generic Errors

The following generic error codes might occur at any of the specified operation.Generic errors are prefixed with 'mdsp.core.generic.'. - 204: noContent - 400: invalidParameter - 400: invalidRequestBodyProperty - 400: missingParameter - 400: missingRequestBodyProperty - 401: unauthorized - 403: forbidden - 404: noMatch - 409: conflict - 429: tooManyRequests - 500: internalServerError See the MindSphere API documentation generic errors page for more information.

  1. mobileApps-{id}-instances - Registers a new mobile installation instance with a registered mobile app. POST {{baseUrl}}/mobileApps/:id/instances

  2. emailEncryptionCertificates-{email} - Update the specified recipient's email encryption certificate. PATCH {{baseUrl}}/emailEncryptionCertificates/:email

  3. templates - Shows a list of templates. GET {{baseUrl}}/templates?filter=<string>&page=0&size=10

  4. multicastEmailNotificationJobs - Sends an email notification to specified recipients with an option to attach files. POST {{baseUrl}}/multicastEmailNotificationJobs

  5. templates-{id} - Update the specified template definition. PATCH {{baseUrl}}/templates/:id

  6. bouncedRecipients - Delete recipient email from bounced recipient list. DELETE {{baseUrl}}/bouncedRecipients/:email

  7. multicastSMSNotificationJobs-{id} - Shows status of an sms job. GET {{baseUrl}}/multicastSMSNotificationJobs/:id

  8. multicastSMSNotificationJobs-{id} - Shows detailed delivery information of an sms job. GET {{baseUrl}}/multicastSMSNotificationJobs/:id/deliveries?page=0&size=10

  9. emailEncryptionCertificates-{email} - Delete the email encryption certificate for the specified recipient email. DELETE {{baseUrl}}/emailEncryptionCertificates/:email

  10. emailEncryptionCertificates - Get a list of email encryption certificates. GET {{baseUrl}}/emailEncryptionCertificates?page=0&size=10