The API is divided into subsections, which are briefly described below.

For details about each section, please refer to the respective section.

Getting started:

1. Create an account for free
2. Explore our professional SMS gateway platform
3. Explore API documentation
4. Test your app with our SMS REST API

1. Authentication:
   This section describes how to authenticate requests to the smSend API. All API methods require authentication.

   • Authentication using a session key
   • Authentication using a user token

2. User:
   The following are utility functions regarding the Authenticated User (e.g. the user status, password reset, etc)

   • Dashboard
   • Verify session
   • Reset password
   • User status

3. Contacts:
   This part of the API is used to manage contacts. A contact can be used both in SMS and Email sending, provided that a phone number and/or an email address are given.

   • Add a contact
   • Add multiple contacts
   • Get a contact
   • Registration of a contact to a list
   • List contact’s custom fields
   • Add contact to sms blacklist
   • Add multiple contacts to sms blacklist
   • Add phone number to sms blacklist

4. Contacts Groups:
   This section describes how groups of contacts are created, updated and deleted. SMS messages and emails can be directly sent to groups of contacts.

   • Create a contacts group
   • Modify an existing contacts group
   • Delete a contacts group
   • List contacts groups
   • Add a contact to a group
   • Remove a contact from a group

5. TPOA:
   Here are described the methods to work with TPOA Aliases (Transmission Path Originating Address, i.e. the SMS Sender Alias). TPOA Aliases can be used only with some specific high quality SMS message types.

   • Create a new alias
   • Get all aliases
   • Get a specific alias
   • Remove an alias

6. Sending SMS messages:
   This is the part of the API that allows to send SMS messages, to single recipients, saved contacts or groups of contacts.

   • Send an SMS message
   • Send a parametric SMS message
   • Send an SMS message to a group
   • Get SMS message state
   • Delete a scheduled message

7. SMS messages history:
   Used to retrieve the SMS messages sending history.

   • Get sent SMS messages history

8. SMS Blacklist / Stop SMS:
   This section allow to insert and to retrieve the list of SMS blacklist / Stop SMS.

   • Add Phone Number to Blacklist
   • Add multiple numbers to sms blacklist
   • Retrieve list of phone numbers in blacklist

9. Receiving SMS messages:
   The methods described in this section are used to retrieve the received SMS messages.

   • Get new received messages
   • Get the received SMS messages
   • Get the received SMS messages after a specified message
   • Get the MO received messages

10. Landing pages API:
    This is the part of the API that regards the Landing Pages service.

    • List the published landing pages

11. Email Campaign API:
    This API exposes methods for creating and managing Email campaigns.

    • Create a new list
    • Modify a list
    • Get list of campaigns by statuses
    • Add a contacts group to a list of distribution
    • Create a new email draft
    • Create new issue using a specified template
    • Send an issue to preloaded contacts

12. Subaccounting:
    If enabled as a superaccount, the user can create subaccounts that can be assigned to third-parties. Superaccounts may or may not share credits with their subaccounts.

    • Get the list of subaccounts
    • Create a subaccount
    • Edit subaccount
    • Change subaccount password
    • Get subaccount
    • Move credits from/to subaccount
    • Get subaccount available credits
    • Get a subaccount’s purchases
    • Create a subaccount purchase
    • Delete a subaccount’s purchase

13. Two Factor authentication:
    This API provides the Two Factor Authentication via SMS.

    • Request a 2FA Pin
    • Verify a 2FA Pin