Skip to main content
POST
/
sms
/
incoming
/
Route an inbound SMS to the destination device
curl --request POST \
  --url https://dashboard.hologram.io/api/1/sms/incoming/ \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fromnumber": "<string>",
  "body": "<string>",
  "base64body": "<string>",
  "deviceid": 123,
  "deviceids": [
    123
  ],
  "phonenumber": "<string>"
}
'
{
  "success": true,
  "data": {
    "msgcount": 123
  }
}

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
fromnumber
string

Source phone number

body
string

SMS message body (plain text)

base64body
string

Base64-encoded message body; takes precedence over body if provided

deviceid
integer

Target device ID

deviceids
integer[]

Target device IDs

phonenumber
string

Target device phone number; used to look up device when deviceid/deviceids are absent

Response

OK

success
boolean

Indicates whether the request was successful.

Example:

true

data
object