Skip to content

smsend/REST-API

Repository files navigation

smSend developer guide

smSend: SMS Rest-API

https://wwww.smsend.it

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.

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

  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.

  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.

  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.

  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.

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

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

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

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

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

  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.