Sendible API Documentation - Version 1.0

Overview

Version 1.0 of the Sendible API lets you write applications that can make use of Sendible's message scheduling technology to schedule Email and SMS messages to be sent at a time in the future.

Sendible's open API currently supports a RESTful interface which means you can send an HTTP GET, POST or DELETE and you'll get an XML document in return.

Authentication

In order to make use of the Sendible API, you need to get an API key. You can use the API key to generate a token which you will need to pass with all subsequent requests.

How do I use it?

To start using the Sendible API, you will need to get a token. You can get a new token with the following GET query (along with your API key):

http://api.sendible.com/auth.svc/getToken?api_key=<API KEY>

This query will return an XML output. For example: 
	<AuthResult>
		<MessageCredits>76</MessageCredits>
		<Status>SUCCESS</Status>
		<Success>true</Success>
		<Token>087e03bc-1ef5-1214-be55-e7fc4d7545b1a</Token>
		<UserLogin>user@sendible.com</UserLogin>
	</AuthResult>
You will then need to use the API Key and Token in all subsequent requests.

Methods

Auth [http://api.sendible.com/auth.svc/]

getToken
Returns an auth result containing a token which can be used to interact with the Sendible API.
URL: http://api.sendible.com/auth.svc/getToken
Format: XML
Method(s): GET
Arguments:
api_key [required]
Your application key.
Sample Result: 
<AuthResult>
	<MessageCredits>76</MessageCredits>
	<Status>SUCCESS</Status>
	<Success>true</Success>
	<Token>087e03bc-1ef5-1214-be55-e7fc4d7545b1a</Token>
	<UserLogin>user@sendible.com</UserLogin>
</AuthResult>
checkToken
Returns an auth result indicating whether your API Key and Token are valid.
URL: http://api.sendible.com/auth.svc/checkToken
Format: XML
Method(s): GET
Arguments:
api_key [required]
Your application key.
token [required]
The token provided in the getToken request..
Sample Result: 
<AuthResult>
	<MessageCredits>76</MessageCredits>
	<Status>SUCCESS</Status>
	<Success>true</Success>
	<Token>087e03bc-1ef5-1214-be55-e7fc4d7545b1a</Token>
	<UserLogin>user@sendible.com</UserLogin>
</AuthResult>

Messaging [http://api.sendible.com/messaging.svc/]

createMessage
Creates a new Sendible message.
URL: http://api.sendible.com/messaging.svc/createMessage
Format: XML
Method(s): POST
Arguments:
api_key [required]
Your application key.
token [required]
The token provided in the getToken request.
from [required]
The person sending the message. For emails use a valid email address. For SMS messages use the mobile number.
to [required]
The destination. For emails use a valid email address. For SMS messages use a valid mobile number, including country code. E.g. 4412345678
subject [required]
The message subject.
message [required]
The message text. This text should be UTF-8 encoded.
minutes_from_now [required]
The number of minutes into the future that this message should be sent. To send immediately, use 0.
message_type [required]
The type of message to be sent.
Valid options (case sensitive): Email, SMS
properties [optional]
Additional properties that may assist in the message delivery. This will be used to support Social Network message types in the future.
Example:
http://api.sendible.com/Messaging.svc/CreateMessage?api_key=<API KEY>&token=<TOKEN>&from=<FROM> &to=<TO>&subject=<SUBJECT>&message=<MESSAGE>&minutes_from_now=<MINS FROM NOW>&message_type=<MSG TYPE>
Sample Result: 
<Result xmlns="http://api.sendible.com" 
	xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Message>
		<MessageId>1111</MessageId>
		<MessageText>test</MessageText>
		<MessageType>Email</MessageType>
		<Recurring>Once-off</Recurring>
		<SendDateGMT>2008-08-12T22:22:34</SendDateGMT>
		<SendFrom>test@sendible.com</SendFrom>
		<SendMinutesFromNow>0</SendMinutesFromNow>
		<SendTo>test@sendible.com</SendTo>
		<Status>Pending</Status>
		<Subject>test</Subject>
	</Message>
	<Status>MESSAGE_SCHEDULED</Status>
	<Success>true</Success>
</Result>
getMessage
Retrieves an existing Sendible message.
URL: http://api.sendible.com/messaging.svc/getMessage/<MESSAGE ID>
Format: XML
Method(s): GET
Arguments:
api_key [required]
Your application key.
token [required]
The token provided in the getToken request.
Example:
http://api.sendible.com/Messaging.svc/GetMessage/1000?api_key=<API KEY>&token=<TOKEN>
Sample Result: 
<Message xmlns="http://api.sendible.com" 
	xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<MessageId>1111</MessageId>
	<MessageText>test</MessageText>
	<MessageType>Email</MessageType>
	<Recurring>Once-off</Recurring>
	<SendDateGMT>2008-08-12T22:22:34</SendDateGMT>
	<SendFrom>test@sendible.com</SendFrom>
	<SendMinutesFromNow>0</SendMinutesFromNow>
	<SendTo>test@sendible.com</SendTo>
	<Status>Pending</Status>
	<Subject>test</Subject>
</Message>
Sendible © 2008