Skip to main content
POST
/
sms
/
outgoing
/
Send an outbound SMS from a device
curl --request POST \
  --url https://dashboard.hologram.io/api/1/sms/outgoing/ \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": "<string>",
  "destinationphonenumber": "<string>",
  "deviceid": 123,
  "phonenumber": "<string>"
}
'
{
  "success": true
}

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

application/json
​
body
string
required

SMS message body

​
destinationphonenumber
string
required

Destination phone number

​
deviceid
integer

Device ID of the sending device; required if phonenumber is not provided

​
phonenumber
string

Phone number of the sending device; required if deviceid is not provided

Response

OK

​
success
boolean

Indicates whether the request was successful.

Example:

true