Skip to main content
POST
/
sms
/
outgoing
Send SMS from device to phone number
curl --request POST \
  --url https://dashboard.hologram.io/api/1/sms/outgoing \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'base64body=<string>' \
  --form 'body=Hello from my IoT device!' \
  --form 'destinationphonenumber=+15551234567' \
  --form deviceid=4020513 \
  --form 'deviceids=<string>' \
  --form 'phonenumber=+15559876543'
{
  "success": true,
  "data": {
    "msgcount": 1
  }
}

Authorizations

​
Authorization
string
header
required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key.

You can find your API key on the Hologram Dashboard under Account Settings.

Body

multipart/form-data
​
base64body
string

Base64 encoded message body (alternative to body)

​
body
string

Plain text message body

Example:

"Hello from my IoT device!"

​
destinationphonenumber
string

Phone number to send SMS to

Example:

"+15551234567"

​
deviceid
integer

Device ID sending the SMS

Example:

4020513

​
deviceids
string

Comma-separated device IDs for bulk sending

​
phonenumber
string

Source phone number for the SMS

Example:

"+15559876543"

Response

SMS sent successfully

​
success
boolean

Indicates if the SMS was sent successfully

​
data
SMSOutgoingData · object