Simple SMS Gateway API Documentation
Our simple SMS Gateway API has been designed to allow developers to integrate our service with the minimum of effort, if you require a more comprehensive solution you may want to look at our RESTful service, however if you want to get up and running quickly then it might still be the best way for you. If you have any integration questions then just call us.
Skills Required
- Understanding of the HTTP (GET) protocol
- Some knowledge of a programming language
- Basic XML
Code Examples for sending SMS
Get started instantly. You can copy & paste the code examples below for use with our simple SMS API Gateway.
<?php // Simple SMS send function function sendSMS($username, $password, $number, $message, $originator) { $URL = 'http://www.textmarketer.biz/gateway/'."?username=$username&password=$password&option=xml"; $URL .= "&number=$number&message=".urlencode($message).'&orig='.urlencode($originator); $fp = fopen($URL, 'r'); return fread($fp, 1024); } // Example of use $response = sendSMS('myUsername', 'myPassword', '4477777777', 'My test message', 'TextMessage'); echo $response; ?>
<?php /// Simple SMS send class class SendSMS { private static $URL = 'http://www.textmarketer.biz/gateway/'; private $my_url; private $error; private $numberOfCreditsRemaining; private $creditsUsed; private $transaction_id; // Use the same username and password you have for your main account function __construct($username,$password) { $this->my_url = self::$URL."?username=$username&password=$password&option=xml"; } // Sends an SMS to the gateway, the message length must be between 1 and 640 characters long. public function send($number, $message, $originator) { $this->error = null; $query_string = "&number=$number&message=".urlencode($message).'&orig='.urlencode($originator); $fp = fopen($this->my_url.$query_string, 'r'); $response = fread($fp, 1024); return $this->processResponse($response); } // Returns an array of error messages public function getError() { $arr = each($this->error); return $arr['value']; } // the total of credits you have left in your account public function getCreditsRemaining() { return $this->numberOfCreditsRemaining; } // This is the unique code that represents your send, you need this code to match up delivery reports public function getTransactionID() { return $this->transaction_id; } // how many credits were used for the send, a message that uses more than 160 characters will use more credits. 1 CR = 160 characters public function getCreditsUsed() { return $this->creditsUsed; } //////// PRIVATE FUNCTIONS private function processResponse($r) { $xml=simplexml_load_string($r); if($xml['status'] == "failed") { foreach($xml->reason as $index => $reason) $this->error[] = $reason; /// parse the errors into an array return false; } else { $this->transaction_id = $xml['id']; $this->numberOfCreditsRemaining = $xml->credits; $this->creditsUsed = $xml->credits_used; return true; } } } // Example of use $sms = new SendSMS("myUsername","myPassword"); if($sms->send("4477777777","My test message","TextMessage")){ echo "I have ".$sms->getCreditsRemaining()." left and I used ".$sms->getCreditsUsed()." credits"; } else { while($error = $sms->getError()) { echo $error; } } ?>
import java.io.BufferedReader; import java.io.IOException; import java.io.InputStreamReader; import java.io.UnsupportedEncodingException; import java.net.URL; import java.net.URLConnection; import java.net.URLEncoder; // Simple send SMS programm public class SendSMS { public static String sendSMS(String username, String password, String number, String message, String originator) { String url; StringBuilder inBuffer = new StringBuilder(); try { url = "http://www.textmarketer.biz/gateway/" + "?username=" + username + "&password=" + password + "&option=xml" + "&number=" + number + "&message=" + URLEncoder.encode(message, "UTF-8") + "&orig=" + URLEncoder.encode(originator, "UTF-8"); } catch (UnsupportedEncodingException e) { return null; } try { URL tmUrl = new URL(url); URLConnection tmConnection = tmUrl.openConnection(); tmConnection.setDoInput(true); BufferedReader in = new BufferedReader(new InputStreamReader(tmConnection.getInputStream())); String inputLine; while ((inputLine = in.readLine()) != null) inBuffer.append(inputLine); in.close(); } catch (IOException e) { return null; } return inBuffer.toString(); } public static void main(String[] args) { // Example of use String response = sendSMS("myUsername", "myPassword", "4477777777", "My test message", "TextMessage"); System.out.println(response); } }
using System;
using System.IO;
using System.Net;
using System.Text;
using System.Web;
namespace SendSMS {
class Program {
public static string SendSMS(string username, string password, string number, string message, string originator) {
StringBuilder sb = new StringBuilder();
byte[] buf = new byte[1024];
string url = "http://www.textmarketer.biz/gateway/" +
"?username=" + username + "&password=" + password + "&option=xml" +
"&number=" + number + "&message=" + HttpUtility.UrlEncode(message) +
"&orig=" + HttpUtility.UrlEncode(originator);
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
HttpWebResponse response = (HttpWebResponse)request.GetResponse();
Stream resStream = response.GetResponseStream();
string tempString = null;
int count = 0;
do {
count = resStream.Read(buf, 0, buf.Length);
if (count != 0) {
tempString = Encoding.ASCII.GetString(buf, 0, count);
sb.Append(tempString);
}
}
while (count > 0);
return sb.ToString();
}
static void Main(string[] args) {
string respXML = SendSMS("myUsername", "myPassword", "4477777777", "My test message", "TextMessage");
Console.WriteLine(respXML);
}
}
}
import urllib def sendSMS(username, password, number, message, originator): params = {'username': username, 'password': password, 'option': 'xml', 'number': number, 'message' : message, 'orig': originator} f = urllib.urlopen('http://www.textmarketer.biz/gateway/?' + urllib.urlencode(params)) return (f.read(), f.code) resp, code = sendSMS('myUsername', 'myPassword', '4477777777', 'My test message', 'TextMessage') print resp
#include <iostream> #include <string> #using <System.Dll> #using <System.Web.Dll> using namespace std; using namespace System; using namespace System::Web; using namespace System::Net; using namespace System::IO; using namespace System::Runtime::InteropServices; ref class SMSSender { private: static String^ Username = "myUsername"; static String^ Password = "myPassword"; public: SMSSender() {} String^ SendSMS(String^ To, String^ Message, String^ From) { Message = HttpUtility::UrlEncode(Message); From = HttpUtility::UrlEncode(From); String^ URL = "http://www.textmarketer.biz/gateway/?&option=xml&username=" + Username + "&password=" + Password + "&message=" + Message + "&orig=" + From + "&number=" + To; WebRequest^ Handle = WebRequest::Create(URL); WebResponse^ HTTPResponse = Handle->GetResponse(); StreamReader^ Stream = gcnew StreamReader(HTTPResponse->GetResponseStream()); String^ Response = Stream->ReadToEnd()->Trim(); HTTPResponse->Close(); return Response; } }; int main() { SMSSender^ test = gcnew SMSSender(); String^ resp = test->SendSMS("4477777777", "My test message", "TextMessage"); Console::WriteLine(resp); return 0; }
/* * Send SMS C/C++ example need curllib download from http://curl.haxx.se/ */ #include <stdio.h> #include <tchar.h> #include <string.h> #include <curl/curl.h> #define URLSIZE 256 struct MemoryStruct { char *memory; size_t size; }; /* Converts a hex character to its integer value */ char from_hex(char ch) { return isdigit(ch) ? ch - '0' : tolower(ch) - 'a' + 10; } /* Converts an integer value to its hex character*/ char to_hex(char code) { static char hex[] = "0123456789abcdef"; return hex[code & 15]; } /* Returns a url-encoded version of str */ char *url_encode(char *str) { char *pstr = str, *buf = (char *)malloc(strlen(str) * 3 + 1), *pbuf = buf; while (*pstr) { if (isalnum(*pstr) || *pstr == '-' || *pstr == '_' || *pstr == '.' || *pstr == '~') *pbuf++ = *pstr; else if (*pstr == ' ') *pbuf++ = '+'; else *pbuf++ = '%', *pbuf++ = to_hex(*pstr >> 4), *pbuf++ = to_hex(*pstr & 15); pstr++; } *pbuf = '\0'; return buf; } /* CURL Callback write function */ static size_t WriteMemoryCallback(void *contents, size_t size, size_t nmemb, void *userp) { size_t realsize = size * nmemb; struct MemoryStruct *mem = (struct MemoryStruct *)userp; mem->memory = (char *)realloc(mem->memory, mem->size + realsize + 1); if (mem->memory == NULL) { /* out of memory! */ printf("not enough memory (realloc returned NULL)\n"); exit(EXIT_FAILURE); } memcpy(&(mem->memory[mem->size]), contents, realsize); mem->size += realsize; mem->memory[mem->size] = 0; return realsize; } /* Send SMS */ char * sendSMS(const char *username, const char *password, const char *number, char *message, char *originator) { static char url[URLSIZE] = "http://www.textmarketer.biz/gateway/?option=xml"; char *encoded; CURL *curl; CURLcode res; struct MemoryStruct chunk; chunk.memory = (char *)malloc(1); /* will be grown as needed by the realloc above */ chunk.size = 0; /* no data at this point */ curl = curl_easy_init(); if(curl) { strcat_s(url, URLSIZE, "&username="); strcat_s(url, URLSIZE, username); strcat_s(url, URLSIZE, "&password="); strcat_s(url, URLSIZE, password); strcat_s(url, URLSIZE, "&number="); strcat_s(url, URLSIZE, number); strcat_s(url, URLSIZE, "&message="); encoded = url_encode(message); strcat_s(url, URLSIZE, encoded); free(encoded); encoded = url_encode(originator); strcat_s(url, URLSIZE, "&orig="); strcat_s(url, URLSIZE, encoded); free(encoded); curl_easy_setopt(curl, CURLOPT_URL, url); /* send all data to this function */ curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteMemoryCallback); /* we pass our 'chunk' struct to the callback function */ curl_easy_setopt(curl, CURLOPT_WRITEDATA, (void *)&chunk); if((res = curl_easy_perform(curl)) != CURLE_OK) { return NULL; } curl_easy_cleanup(curl); } return chunk.memory; } int main(void) { char *response; response = sendSMS("myuser", "mypass", "4477777777", "test test test", "me"); if(response != NULL) { printf(response); free(response); } getchar(); return 0; }
Module Module1 Public Function SendSMS(ByVal username As String, ByVal password As String, ByVal number As String, ByVal message As String, ByVal originator As String) Dim webClient As New System.Net.WebClient Dim url As String = "http://www.textmarketer.biz/gateway/?username=" & username & "&password=" & password & "&option=xml" & "&number=" & number & "&message=" & System.Web.HttpUtility.UrlEncode(message) & "&orig=" & System.Web.HttpUtility.urlencode(originator) Dim result As String = webClient.DownloadString(url) SendSMS = result End Function Sub Main() Dim result As String = SendSMS("myUsername", "myPassword", "4477777777", "My test message", "TextMessage") Console.WriteLine(result) Console.ReadKey() End Sub End Module
<%@language=JScript%>
<%
username = "myUsername";
password = "myPassword";
number = "4477777777";
message = Server.URLEncode("My test message");
originator = Server.URLEncode("TextMessage");
url = "http://www.textmarketer.biz/gateway/?&option=xml" +
"&username=" + username + "&password=" + password +
"&number=" + number + "&message=" + message +
"&orig=" + originator;
var objSrvHTTP;
objSrvHTTP = Server.CreateObject("Msxml2.ServerXMLHTTP");
objSrvHTTP.open(url, false);
objSrvHTTP.send();
Response.ContentType = "text/xml";
xmlResp = objSrvHTTP.responseXML.xml;
Response.Write(xmlResp);
%>
require 'net/http' require 'uri' def send_sms(username, password, number, message, originator) requested_url = 'http://www.textmarketer.biz/gateway/?option=xml' + "&username=" + username + "&password=" + password + "&number=" + number + "&message=" + URI.escape(message) + "&orig=" + URI.escape(originator) url = URI.parse(requested_url) full_path = (url.query.blank?) ? url.path : "#{url.path}?#{url.query}" the_request = Net::HTTP::Get.new(full_path) the_response = Net::HTTP.start(url.host, url.port) { |http| http.request(the_request) } raise "Response was not 200, response was #{the_response.code}" if the_response.code != "200" return the_response.body end resp = send_sms('myUsername', 'myPassword', '4477777777', 'My test message', 'TextMessage') puts(resp)
Example uses of the SMS Gateway API
- SMS appointment reminders from software
- SMS alerts from software such as server monitoring software
- Sign up confirmation texts and forgot password texts
- Order confirmations by SMS such as train tickets or cinema tickets
- SMS notifications when products back in stock for registered users
- 'Mail merged' data SMS campaigns for coupon code promotions
In fact, any communication where your application might send an email, you can send a text message instead (or as well). The main benefit is that 99% of text messages are read, compared to only around 10% of emails. So, if the information you need to send is important then sending a text via the SMS Gateway API is your solution.
This SMS Gateway API is great for a quick set up for sending out text messages. Often, people will also want to pipe text responses back into a system or to an email address. You may consider a virtual mobile number to achieve this.



