POST
/
v1
/
sms
curl --request POST \
  --url https://api.terrareach.com/api/v1/sms \
  --header 'Content-Type: application/json' \
  --data '{
  "mask": "<string>",
  "message": "<string>",
  "phoneNumber": "<string>",
  "apiKey": "<string>"
}'
{
  "id": "<string>",
  "text": "<string>",
  "senderId": "<string>",
  "to": "<string>",
  "type": "TRANSACTIONAL",
  "initiatedMedium": "API_CALL",
  "deliveryStatus": "SUCCESSFULLY_SUBMITTED_TO_SMSC"
}

Body

application/json
​
mask
string
required
​
message
string
required
​
phoneNumber
string
required
​
apiKey
string
required

Response

200
*/*
OK
​
id
string
​
text
string
​
senderId
string
​
to
string
​
type
enum<string>
Available options:
TRANSACTIONAL,
CAMPAIGN
​
initiatedMedium
enum<string>
Available options:
API_CALL,
WEB_INTERFACE
​
deliveryStatus
enum<string>
Available options:
SUCCESSFULLY_SUBMITTED_TO_SMSC,
NUMBER_NOT_VALID_OR_CONNECTIVITY_FAILURE,
DELIVERED,
FAILED

Was this page helpful?

IntroductionSend Bulk SMS