Introduction
The HelloSMS API is built around RESTful principles. Our API utilizes standard HTTP protocols, returning JSON payloads in response to HTTP requests. All operations are performed via GET and POST methods.
Requirements
To use the HelloSMS API, you must have an active HelloSMS account with an API user configured. To create an API user, please refer to the Create an API User guide.
Quick Example: Send an SMS
Here’s a simple example to show you how easy it is to send an SMS using the HelloSMS API. This example uses the Send SMS endpoint:
curl -X POST "https://api.hellosms.se/api/v1/sms/send \
-H "Authorization: <base64_encoded_credentials>" \
-H "Content-Type: application/json" \
-d '
{
"to": [
"46701740610"
],
"from": "46701740609",
"subject": "Hello World!",
"message": "Hello, first time using HelloSMS? Visit https://hellosms.se/sms-api to get started!"
}'
Response
If the request is successful, you’ll receive a JSON response like this:
{
"status": "success",
"statusText": "message received successfully by the system",
"messageIds": [
{
"apiMessageId": "api-67e446f54e5d24.82694461",
"to": "+46279388",
"status": 0,
"message": "Hello, first time using HelloSMS? Visit https://hellosms.se/sms-api to get started!"
}
],
"originalMessage": "Hello, first time using HelloSMS? Visit https://hellosms.se/sms-api to get started!",
"messageCount": 1,
"textLength": 83,
"encoding": "standard",
"shortenLinks": false,
"from": "46701740609"
}
For more details, check out the Send SMS documentation.
API Services
HelloSMS offers a wide range of functionalities through its API. Below are links to every API service available in the documentation: