LOGIN

(To access this page fully you need to login as an administrator)
 






 
 

Don‘t yet have an account?

Registration is free!

Forgotten your password?

ENLARGE HELP TEXT

SHRINK HELP TEXT

DEVELOPER API

The API enables you to interface with the Txtreme SMS system from your own: Website, Email, PC, Mobile, Tablet or APP.
 
This basically means you can easily and seemlessly send SMS messages from your own systems
 
There is extensive on-screen help available detailing the usage of our Developer API, with full examples of use and description of each function available and definition of fields used.
 
Also some additional downloadable information, click on the links and images for more.

DEVELOPER API

Txtreme SMS - Developer API

 
API OPERATIONAL
 

QUICK LINKS


 

Txtreme SMS Developer API Quick Start Guide

Txtreme SMS Developer API Functions

Txtreme SMS Developer API DB Fields

Txtreme SMS Developer API DB Schema / Layout PDF

 
  GUIDE FUNCTIONS
All  or  Individual
FIELDS
All  or  Individual
SCHEMA  
 

TXTREME DEVELOPER API

The Txtreme Developer API allows you to send SMS / Text messages seamlessly from you own system using a vaiety of languages, methods and protocols (see Txtreme.co.uk/developer-api/ for examples).
 
Firstly you will need to create a CLIENT API KEY, this along with a password of your choice is used to call the API (This can be done once you are logged in as an administrator user, Admin, Client API Keys, NEW API KEY button.)
 

Example code is supplied for each function, see:

There are many ways you can send message:

  • MSG_SEND - Individual message
  • MSG_BULK - Bulk lists from your pre-defined Address book
  • MSG_MULTI - Up to 999 'API entries' of Individual and/or Bulk messages, to be processed in one go.
  • MSG_CSV - Bulk messages, from a CSV format list

Each of these functions, also has a function '_CALC', e.g: MSG_SEND_CALC

  • This is used to validate all entries passed to the API prior to processing/sending
  • If addressbook entries have been selected then these are validated/verified
  • Optional a Summary or Detailed list/report is returned identifying valid/invalid entries in the passed list (valid = 1 or 0)
  • Also returned in the summary:
    • calc_no_valid - number of valid entries to be sent
    • calc_no_errors - number of entries with an error
    • calc_enough_units = 1 or 0 (whether you have enough Credits/Units on Account to process the API call)
 
After a '_CALC' function has been called, if you are happy with the results and you have enough credit/units to process it, then you can process the immediate previous '_CALC' call using 'MSG_LAST_CALC' without the need to pass any of the other parameters again.
 

Other functions exist

Please refer to the function list below or the Full list of functions/help
 
 
 
API
 
 
Txtreme Developer API
 

API METHODS


Txtreme SMS Developer API Methods
 
 
API METHODS
 
Calling the API can be done from any language that allows external calls (Https: etc.) to other systems, (for example PHP, Javascript, jQuery, Visual Studio Basic/C++, Android, Xcode, Swift 3, etc.) using any of the standard protocols XML, JSON, GET or POST to pass the parameters of your API call.
 

 
To display the Function help, select from the droptdown here or click on a function at the bottom of this page - this will display all available information about the function, parameters in, results out, API key secturity level needed and example code.
 
Display function help: 
 

 
   
 

API CALLING

 
 
API CALLING
 

Example code is included in the function help text, the standard main 4 parameters are:

  • fn= (function API is to process, e.g. MSG_SEND)
  • output= (format of the API output results - HTML, XML, JSON, TEXT or CSV)
  • pwd= (your API password)
  • key= (your 55 character API key)
 

Depending on the function

Additional parameters are required, e.g. for MSG_SEND  
  • mobile_no= (mobile number to text, will automatically match to address book entry)
  • abe_id= (or address book entry id)
  • email= (optional email address to send additional email, or 'NO' to no send email
  • message= (message of the text to be sent)
 
Then call 'https://www.txtreme.co.uk/api/get/'

Txtreme SMS Developer API Calling
   
 

API SEND SMS & EMAIL


Txtreme SMS Developer API Email SMS
 
 
API SEND SMS & EMAIL
 
When you send an SMS message, an email will can be optionally sent as well - you can either:
  • Pass the email address in parameter 'email=' to the API and/or
  • The API aquires the email address by matching the mobile number in your Txtreme Addressbook
  • If you do not want emails to automatically be send, pass email=NO
   
 

API QUICK START GUIDE

   
Our API is aimed at developers, but enough example code has been included in the on-screen help and in this quide to get most users up and running - however it is still recommended to get a professional to do this. This guide gives you the basics to get started interfacing with the Txtreme System via it's API.
 
DOWNLOAD OUR

TXTREME Developer API - Quick Start Guide
 
Txtreme SMS Developer API Quick start guide Download
 

Txtreme Developer API Quick STart Guide
 

API CLIENT KEYS


Txtreme SMS Developer API Keys
 
 
API CLIENT KEYS
 
You can have any number of API Keys for your account, each with a difference API Level and Password - So you can have different ones for differnet uses.
 
Below you can click the '+' to add a new API Key or select an API key from the dropdown to EDIT
Within EDIT, you have the option to:
  • Amend the API keys parapeters
  • Suspend or delete the API Key
  • View the Audit summmary
  • View the API Calls ful audit file for each API Call and also
  • Access the advanced TEST API feature - where you can actually test, on-screen LIVE with your data, each function, as though it was called from an API
 

    Txtreme - Login as an administrator for further options    
   
 

API KEY TEST

 
 
API KEY TEST
 
Select an API Key (or '+' to add one) - this will take you into the advances on-screen TEST API FEATURE, using that API Key.
 
You can then test the API on screen using your LIVE data as though you called the API directly - but it is all done on screen and the results returned on screen - unlike an actual API call which is all hidden behind the scenes
 
PLEASE NOTE: This feature, will send SMS messages live from your account - depending on which function you select
 

    Txtreme - Login as an administrator for further options    

Txtreme SMS Developer API KEY Test
   
 

API KEY EDIT


Txtreme SMS Developer API Key Edit
 
 
API KEY EDIT
 
Select an API Key (or '+' to add one) - will take you to the API Key edit screen, where you can amend the API Key's setting, such as the password, activate/deactivate and set quota levels (maximum number of SMS to be sent, 0 = unlimited)
 
Also at the bottom of this screen;
  • You can see an AUDIT USAGE SUMMARY and 2 further options to
  • View the FULL audit history and the
  • Advanced TEST API KEY option
 

    Txtreme - Login as an administrator for further options    
   
 

API KEY AUDIT HISTORY

 
 
API KEY AUDIT
 
Select an API Key (or '+' to add one) - will take you to the FULL API Key audit screen for that Client API Key
 
Within this screen you will see a daily summary of each API call made using that specific CLIENT API KEY, selecting a specific day, you will see details of each API call
 

    Txtreme - Login as an administrator for further options    

Txtreme SMS Developer API Key Audit
   
 

API EMAIL TO SEND SMS


Txtreme SMS Developer API Email to SMS
 
 
API EMAIL TO SEND SMS
 
This feature, will be available in a future release of the API and will allow sending of SMS messages directly by sending an email to [email protected]
 
The email should either contain the API Key or the preferrable method, that the email is sent from the email address specified in the API key,
 
The phone number should either be at the top of the email or in the subject, and the message to be send contained in the body of the email
 

    Txtreme - Login as an administrator for further options    
   
 

API DATABASE DIAGRAM

 
 
API DATABASE DIAGRAM

 
Download the Database Schema diagram,
click on the image size required
 
 

Txtreme SMS Developer API DB Layout A3    Txtreme SMS Developer API DB Layout A4    Txtreme SMS Developer API DB Layout PDF

Txtreme SMS Developer API DB Layout
   
 

API DATABASE FIELD HELP


Txtreme SMS Developer API DB Fields
 
 
API DATABASE FIELD HELP
 

 Select a DATABASE FIELD to view help text:
 
   
 
Txtreme SMS Developer API Fields Documentation
   
 

API FUNCTION HELP

 
 
API FUNCTIONS
Click on the function text or select from the dropdown
to display that functions online documentation.

 
 
  TEST_KEY  API_VERSION  FUNCTION_ALL  FUNCTION_LIST  
  FUNCTION_VALID  FUNCTION_FIELDS  FUNCTION_HTTP  MSG_SEND  
  MSG_SEND_CALC  MSG_SEND_LIST  MSG_BULK  MSG_BULK_CALC  
  MSG_BULK_LIST  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_LIST  
  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  MSG_CSV  
  MSG_CSV_CALC  MSG_CSV_LIST  MSG_LAST_CALC  MSG_LIST  
  MSG_LIST_FULL  MSG_GET_STATUS  MSG_GET_FULL  INBOX_LIST_FULL  
  INBOX_GET_FULL  AC_BAL_GET  USER_LIST  USER_GET  
  USER_SEC_LEVELS  API_KEY_ENABLE  API_KEY_SUSPEND  API_KEY_LOCK  
  API_KEY_UNLOCK  API_KEY_LEVELS  WEBSITE_SIGNIN  HTTP_STATUS  
 
Txtreme SMS Developer API Function Documentation
 
 
  Display function help: