How to send an SMS

📘

The SMS API must be enabled on the SecureEdge's Compliance page.

📘

Sending SMS messages is only possible on a SecureEdge with cellular capabilities.

Introduction

You can use the SMS API to send a text message to a mobile phone number.

Send an SMS

Send an HTTP POST request to the /api/v1/network/sms endpoint:

curl --request POST \
     --url 'http://192.168.140.1:80/api/v1/network/sms' \
     --header 'Content-Type: application/json' \
     --data '
     {
         "recipient": "+31612345678",
         "message": "Your message here."
     }
     '

HTTP/1.1 200 OK

HTTP/1.1 429 Too Many Requests

Too Many Requests! Wait for 45s

HTTP/1.1 504 Gateway Timeout

the text message was queued and transmission could not be verified

HTTP/1.1 403 Forbidden

Both arguments are required. The structure of the phone number provided through the recipient argument must follow the E.164 notation. Briefly summarized, this means it should start with a plus sign (+), followed by the country code, area code, and subscriber number, with a maximum length of 15 digits. The message argument may not be empty, and can consist of at most 134 characters.

The SMS API is rate limited, and you will receive a 429: Too Many Requests if you make more than 5 API calls per minute.