Send Notifications

1min
POST
https://{domain}/core/api/v1/messaging-service/messages/{notification}
Send Notification to multiple users via any of following modes [sms,email,whatsapp]
Path Parameters
notification
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-APP-ID
string
*
X-COREOS-USERINFO
string
X-COREOS-CALLBACK-SECRET
string
Body Parameters
body
SendNotificationBody
*
Description
Request body for sending notification
notifications
object[]
*
callback
object
Responses
202
Accepted
object
All Of
object  +
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
*
request
Request
*
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that Tenant.
ErrorResponse
error
Error
*
request
Request
*
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/core/api/v1/messaging-service/messages/{notification}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "notifications": [
    {
      "data": {},
      "sms": {
        "to": [
          {
            "countryCode": "",
            "number": ""
          }
        ]
      },
      "email": {
        "to": [
          ""
        ]
      },
      "whatsapp": {
        "to": [
          {
            "countryCode": "",
            "number": ""
          }
        ]
      }
    }
  ],
  "callback": {
    "url": ""
  }
}'
curl --location --globoff 'https://{domain}/core/api/v1/messaging-service/messages/{notification}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "notifications": [
    {
      "data": {},
      "sms": {
        "to": [
          {
            "countryCode": "",
            "number": ""
          }
        ]
      },
      "email": {
        "to": [
          ""
        ]
      },
      "whatsapp": {
        "to": [
          {
            "countryCode": "",
            "number": ""
          }
        ]
      }
    }
  ],
  "callback": {
    "url": ""
  }
}'
Responses
202
400
401
404
// Accepted 
{}
// Accepted 
{}
﻿
﻿
Updated 28 Jun 2024
Did this page help you?
Send messages
/two-way/messages