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.

post

/user/v1/notification/email

Header parameters

Authorizationstringrequired

To make use of the API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

Body

requestRequestrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://staging.open-sunbird.org/api/user/v1/notification/email ' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"name":"Amit","subject":"test email","body":"Hello Amit.","downloadUrl":"https://www.google.com/","mode":"sms","recipientEmails":["[e-mail]","[e-mail]"],"recipientPhones":["valid phone number without country code"],"recipientUserIds":["valid userId"],"recipentSearchQuery":{"filters":{"channel":"nameof channel","rootOrgId":"rootOrgIds","organisations.roles":["valid roles"]}}}}'

200

400

500

200

{
  "id": "api.notification.email",
  "ver": "v1",
  "ts": "2020-12-01 10:49:01:948+0000",
  "responseCode": "OK",
  "params": {
    "resmsgid": null,
    "msgid": "12eb0ca45ce4c776fab994d120bedd41",
    "err": null,
    "status": "success",
    "errmsg": "null."
  },
  "result": {
    "response": "SUCCESS"
  }
}

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