Send SMS
By emanuele.dunp
Updated 6 months ago

Send SMS API Documentation

Send text messages

Learn more about this API
Landing_pages API
GETList the published landing pages
SMS History API
GETGet sent SMS messages history
Contacts groups_API
PUTModify an existing contacts group
GETList contacts groups
DELETERemove a contact from a group
DELETEDelete a contacts group
Subaccount API
GETGet a subaccount’s purchases
POSTCreate a subaccount
POSTMove credits from/to subaccount
PUTEdit subaccount
POSTCreate a subaccount purchase
GETGet subaccount available credits
DELETEDelete a subaccount’s purchase
GETGet the list of subaccounts
POSTChange subaccount password
GETGet subaccount
Contacts API
POSTAdd phone number to sms blacklist
GETGet a contact
GETList contact’s custom fields
POSTAdd multiple contacts to sms blacklist
POSTAdd a contact
POSTAdd multiple contacts
POSTAdd contact to sms blacklist
POSTRegistration of a contact to a list
SMS Blacklist/Stop SMS
GETRetrieve list of phone numbers in blacklist
POSTAdd multiple numbers to sms blacklist
POSTAdd Phone Number to Blacklist
POSTSend a parametric SMS message
POSTSend an SMS message to a group
DELETEDelete a scheduled message
POSTSend an SMS message
GETGet SMS message state
Two_Factor Authentication
POSTRequest a 2FA Pin
POSTVerify a 2FA Pin
Email_Campaign API
POSTCreate a new list
POSTAdd a contacts group to a list of distribution
GETGet list of campaigns by statuses
PUTModify a list
GETGet all aliases
DELETERemove an alias
GETGet a specific alias
GETGet new received messages for one or more specific SIMs
GETGet the received SMS messages for all SIMs
Authentication API
GETAuthenticate using a user token
GETAuthenticate using a session key
User API
POSTReset password
GETVerify session
GETUser status
Email Campaign API
POSTCreate a new email draft
POSTSend an issue to preloaded contacts
POSTCreate new issue using a specified template
Received_SMS API
GETGet the received SMS messages after a specified message.
GETGet the MO received messages
GETGet new received messages for all SIMs
GETGet the received SMS messages for one or more specific SIMs
Contacts_groups API
POSTAdd a contact to a group
POSTCreate a contacts group
POSTSend a parametric SMS message

Sends a parametric SMS message to a given list of recipients. With this API it is possible to put placeholders in the message body, and then, for each recipient, specify the values that will replace the placeholders in the message body, for that particular recipient message.

Header Parameters
REQUIREDYour authenticate Session key
REQUIREDYour authenticate User key
Required Parameters
REQUIREDA map of recipents and relative parameters
REQUIREDThe body of the message
Optional Parameters
scheduled_delivery_timezone STRING
OPTIONALOptional timezone applied to scheduled_deliry_time date
OPTIONALSpecifies a custom order ID
OPTIONALThe messages will be sent at the given scheduled time
OPTIONALThe Sender name
OPTIONALThe SMS encoding. Use UCS2 for non standard character sets
returnRemaining BOOLEAN
OPTIONALReturs the number of remaining SMSs
OPTIONALReturns the number of credits used instead of the number of messages. i.e. when message is more than 160 chars long more than one credit is used
id_landing STRING
OPTIONALThe id of the published page
short_link_url STRING
OPTIONALThe url where the short link redirects
campaign_name STRING
OPTIONALThe campaign name
returnCredits BOOLEAN
OPTIONALReturns the number of credits used instead of the number of messages
OPTIONALSending to an invalid recipient does not block the operation
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication