SMS

To send SMS messages from your application you must perform a HTTP POST to the following endpoint:

http://127.0.0.1:43770/api/internal/messages

SMS messages are a paying service and before sending messages you must check if have enough credits via user.bluecherry.io/credits. If you don't have enough credits you can by an SMS credit package through the web shop on user.bluecherry.io/webshop.

Sending an SMS message requires you to perform a POST request like in the following example:

POST /api/internal/messages HTTP/1.1
Host: 127.0.0.1:43770
Content-Type: application/json
Content-Length: 125

[
    {
        "type": 2,
        "destination": "+32123456789",
        "message": "Hi, this is a test SMS message"
    }
]

Every communication request body is a JSON array, this array contains one or more JSON message objects. The message body for an SMS contains the following required fields:

  • type: '2' denotes that you want to send an SMS message.
  • destination: this field contains the phone number of the recipient of the SMS message.
  • message: this field contains the contents of the SMS message. If the content is longer than 160 characters it will be automatically split over multiple SMS messages.