Skip to main content
POST
/
sms
/
incoming
curl --request POST \
  --url https://dashboard.hologram.io/api/1/sms/incoming \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": "Hello from Hologram!",
  "deviceids": [
    4020513
  ],
  "fromnumber": "15551234567",
  "encoding": "gsm0338",
  "data_coding": 0
}
'
{
  "data": {
    "msgcount": 1
  },
  "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
​
base64body
string

base64 encoded bodies can be used instead of a plaintext body

​
deviceid
integer
​
deviceids
integer[]
​
fromnumber
string<integer>
​
encoding
string

This param determines how the message payload should be encoded. Examples: gsm0338, latin-1, utf_16_be. Tip: to see if an encoidng is supported run this python code (and also check with engineering team): import codecs codecs.lookup(encoding_name)

​
data_coding
integer

This parama is a metadata param that tells the Carrier's SMSC what encoding is used for the message payload. If not set, the defaults are: Verizon: 1, IA5 (CCITT T.50)/ASCII (ANSI X3.4) All other carriers: 0, MC Specific See https://smpp.org/SMPP_v5.pdf section 4.7.7 for more info.

Response

200 - application/json

Item created

​
data
Data · object
​
success
boolean