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 'body=Hello from my IoT device!' \
  --form 'destinationphonenumber=+15551234567' \
  --form deviceid=4020513 \
  --form 'phonenumber=+15559876543'
{
  "success": true,
  "data": {
    "msgcount": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.hologram.io/llms.txt

Use this file to discover all available pages before exploring further.

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
​
body
string
required

Plain text message body

Example:

"Hello from my IoT device!"

​
destinationphonenumber
string
required

Phone number to send the SMS to

Example:

"+15551234567"

​
deviceid
integer

ID of the device sending the SMS. Required if phonenumber is not provided.

Example:

4020513

​
phonenumber
string

The device's assigned phone number, used as an alternative to deviceid to identify the sending device.

Example:

"+15559876543"

Response

SMS sent successfully

​
success
boolean

Indicates if the SMS was sent successfully

​
data
SMSOutgoingData · object