Send SMS
FREE
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
SMS_Send API
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
TPOA_API
GETGet all aliases
DELETERemove an alias
GETGet a specific alias
Received_SMS_API
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
GETDashboard
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
PUTEdit subaccount

Edits the subaccount identified by the given subaccount_id. Calling user must be a superaccount.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Session_keySTRING
REQUIREDYour authenticate Session key
lock-subaccount BOOLEAN
OPTIONALActivate or deactivate the subaccount
user_keySTRING
REQUIREDYour authenticate User key
Required Parameters
cell STRING
REQUIREDThe subaccount mobile phone number
provinceSTRING
REQUIREDThe subaccount province
zip-code STRING
REQUIREDThe subaccount ZIP Code
citySTRING
REQUIREDThe subaccount city
emailSTRING
REQUIREDThe subaccount email
pivaSTRING
REQUIREDThe subaccount VAT number (P.Iva in Italy)
addressSTRING
REQUIREDThe subaccount address
credit-eat-mode NUMBER
REQUIREDTells from who credits are scaled. 0 = own credits, 1 = superaccount credits, 2 = own credits and superaccount ones
surnameSTRING
REQUIREDThe subaccount last name
nameSTRING
REQUIREDThe subaccount owner first name
company-name STRING
REQUIREDThe company name
loginSTRING
REQUIREDThe subaccount login username (must not contain any spaces)
subaccount_idNUMBER
REQUIREDThe subaccount ID
Optional Parameters
id-subaccount-profile NUMBER
OPTIONALSpecifying a custom subaccount profile allows a superaccount to narrow down the subaccount enabled features (e.g. Only send SMS messages, or even further, only send a specific type of SMS message)
companyBOOLEAN
OPTIONALIs the subaccount a company?
passwordSTRING
OPTIONALThe subaccount password (min 8 chars, max 16 chars)
superaccountBOOLEAN
OPTIONALThe subaccount is a superaccount itself (i.e. it can create his own subaccounts)
invoicing-email STRING
OPTIONALIf provided, invoices will be sent here instead of the default email
dfeuBOOLEAN
OPTIONALUse the Date Format in EUropean format
phoneSTRING
OPTIONALThe subaccount phone number
languageSTRING
OPTIONALThe subaccount language. If none, defaults to the one of the superaccount
use24BOOLEAN
OPTIONALUse the 24 hour format for time
id-subaccount-profile NUMBER
OPTIONALSpecifying a custom subaccount profile allows a superaccount to narrow down the subaccount enabled features (e.g. Only send SMS messages, or even further, only send a specific type of SMS message)
num-cell-for-test-sms STRING
OPTIONALA phone number where test SMS messages will be sent
faxSTRING
OPTIONALThe subaccount FAX number
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication