We created a new viewing experience for our SMS API documentation. It's now all in one central location. Click here to check it out!

This method will create a new message.


  • list_id - list identifier required in one of the two following formats:
    • integer - the list id as a numeric value, this can be found by requesting 'contact-lists.get' and using corresponding id values from the dataset
    • string - the list name EXACTLY as it is in the 'contact-lists.get' response.
  • message - string - the sms body, can contain special system set variables such as [firstname], [lastname], [opt-out-info] etc.
  • caller_id - string - required in one of the two following formats:
    • numeric - up to 15 numeric characters (e.g. your mobile number if you want replies to come straight to your phone).
    • string - maximum of 11 characters, a-z, 0-9 and _ are valid characters, no spaces.
  • sendTime - integer - Unix Timestamp in GMT for when to send the message. If not supplied the message is sent immediately
  • validity - integer - the maximum number of minutes to attempt sending the message (1-4320)



XML Request Example

<?xml version='1.0'?>








		<message>my sms body</message>


		<optout />

		<sendtime />



XML Response Example

<?xml version='1.0'?>




	<time>2009-12-11 01:41:47 GMT</time>

	<timestamp>1260495707 GMT</timestamp>





		<message>my sms body</message>




		<datetime_send>2009-12-10 14:41:46</datetime_send>



PHP Example

Download the PHP API Client


// change api key and secret to your own

$myAPIKey = "API_KEY";

$myAPISecret = "API_SECRET";

// include base class


// create new client object

$transmitsmsAPI = new transmitsmsAPI($myAPIKey, $myAPISecret);

// set parameters

$list_id = 1075;

$body = 'my sms body';

$caller_id = 'John';

// execute request

$methodResponse = $transmitsmsAPI->addMessage($list_id, $body, $caller_id);

// parse response into xml object

$xml = @simplexml_load_string($methodResponse);

echo ((string) $xml->data->result == 'queued') ? "Message was added" : "Message was not added: " . (string) $xml->data->result;


GET Example

Using a URL based request system you can request this method by using the below URL - be sure to url encode all your variables!