Notification APIs

Notifiying Users

This API is associated with notifying a user on the Sunbird Platform. If the request will contain the mode attribute with value as sms, then the user will be notified via sms else the user will be notified with email. During sms notification you can pass list of phone number or list of phone number and userid both.

• The /email/ endpoint executes the notification request based on parameters provided as metadata in the request body.
• It is mandatory to provide values for parameters marked with * .
• Mandatory fields cannot be null or empty.

POSThttps://staging.open-sunbird.org/api/user/v1/notification/email

Header parameters

Body

application/json

The body refers to the format of the request.

• The body contains metadata about the notification to be sent.

request*Request

Response

200400500

OK ! Successful operation."Notifying User" operation was successfully executed.

Body

application/json

resultSend Notification Result

idstring

API Identifier

verstring

API version information

tsstring

API execution timespan

paramsResponse Parameter

responseCodeobject

API response code

Request

JavaScriptCurl

const response = await fetch('https://staging.open-sunbird.org/api/user/v1/notification/email ', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "name": "Amit",
        "subject": "test email",
        "body": "Hello Amit.",
        "downloadUrl": "https://www.google.com/",
        "recipientEmails": [
          "[e-mail]",
          "[e-mail]"
        ],
        "mode": "sms",
        "recipientPhones": [
          "valid phone number without country code"
        ],
        "recipientUserIds": [
          "valid userId"
        ],
        "recipentSearchQuery": {
          "filters": {
            "channel": "nameof channel",
            "rootOrgId": "rootOrgIds",
            "organisations.roles": [
              "valid roles"
            ]
          }
        }
      }
    }),
});
const data = await response.json();

Response

{
  "result": {
    "response": "text"
  },
  "id": "text",
  "ver": "text",
  "ts": "text",
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "err": "text",
    "status": "text",
    "errmsg": "text"
  },
  "responseCode": {}
}