Esendex API documentation version v1.0
https://api.esendex.com/v1.0
Accounts
get /accounts
HTTP status code 200
Body
Type: application/xml
Example:<?xml version="1.0" encoding="utf-8"?>
<accounts xmlns="http://api.esendex.com/ns/">
<account id="A00F0218-510D-423D-A74E-5A65342FE070" uri="http://api.esendex.com/v1.0/accounts/A00F0218-510D-423D-A74E-5A65342FE070">
<reference>EX0000000</reference>
<label>EX0000000</label>
<address>447700900654</address>
<type>Professional</type>
<messagesremaining>2000</messagesremaining>
<expireson>2999-02-25T00:00:00</expireson>
<role>PowerUser</role>
<settings uri="http://api.esendex.com/v1.0/accounts/A00F0218-510D-423D-A74E-5A65342FE070/settings" />
</account>
</accounts>
get /accounts/{accountId}
URI Parameters
- Account ID: required (string)
HTTP status code 200
Body
Type: application/xml
Example:<?xml version="1.0" encoding="utf-8"?>
<account id="D35FA8EB-3C12-4E8E-8DEC-8568B2F35890" uri="http://api.esendex.com/v1.0/accounts/D35FA8EB-3C12-4E8E-8DEC-8568B2F35890" xmlns="http://api.esendex.com/ns/">
<reference>EX0000000</reference>
<label>EX0000000</label>
<address>447700900654</address>
<type>Professional</type>
<messagesremaining>2000</messagesremaining>
<expireson>2999-02-25T00:00:00</expireson>
<role>PowerUser</role>
<settings uri="http://api.esendex.com/v1.0/accounts/A00F0218-510D-423D-A74E-5A65342FE070/settings" />
</account>
Message Headers
get /messageheaders
Query Parameters
- startindex (string)
The zero-based index of the first resource to return
- count (number)
The number of resources to return
HTTP status code 200
Body
Type: application/xml
Schema:MessageHeadersGetAll
Example:<?xml version="1.0" encoding="utf-8"?>
<messageheaders startindex="0" count="15" totalcount="200" xmlns="http://api.esendex.com/ns/">
<messageheader id="1B9A0D33-4B76-4A9D-919C-1165A9CF1565" uri="http://api.esendex.com/v1.0/messageheaders/1B9A0D33-4B76-4A9D-919C-1165A9CF1565/">
<reference>EX0000000</reference>
<status>Delivered</status>
<laststatusat>2012-01-01T12:00:05.000</laststatusat>
<submittedat>2012-01-01T12:00:02.000</submittedat>
<type>SMS</type>
<to>
<phonenumber>447700900123</phonenumber>
</to>
<from>
<phonenumber>447700900654</phonenumber>
</from>
<summary>Testing REST API</summary>
<body uri="http://api.esendex.com/v1.0/messageheaders/1B9A0D33-4B76-4A9D-919C-1165A9CF1565/body"/>
<direction>Outbound</direction>
<parts>1</parts>
<username>[email protected]</username>
</messageheader>
</messageheaders>
get /messageheaders/{messageHeaderId}
URI Parameters
- Message Header ID: required (string)
HTTP status code 200
Body
Type: application/xml
Example:<?xml version="1.0" encoding="utf-8"?>
<messageheader id="CDEB3533-1F76-46D7-A2A9-0DAF8290F7FC" uri="http://api.esendex.com/v1.0/messageheaders/CDEB3533-1F76-46D7-A2A9-0DAF8290F7FC/" xmlns="http://api.esendex.com/ns/">
<status>Delivered</status>
<laststatusat>2010-01-01T12:00:05.000</laststatusat>
<submittedat>2010-01-01T12:00:02.000</submittedat>
<type>SMS</type>
<to>
<phonenumber>447700900123</phonenumber>
</to>
<from>
<phonenumber>447700900654</phonenumber>
</from>
<summary>Testing REST API</summary>
<body uri="http://api.esendex.com/v1.0/messageheaders/CDEB3533-1F76-46D7-A2A9-0DAF8290F7FC/body"/>
<direction>Outbound</direction>
<parts>1</parts>
<username>[email protected]</username>
</messageheader>
Message Dispatcher
post /messagedispatcher
Body
Type: application/xml
Schema:<?xml version="1.0" encoding="ISO-8859-1" ?>
<xs:schema attributeFormDefault="unqualified"
elementFormDefault="unqualified"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:simpleType name="langType">
<xs:restriction base="xs:string">
<xs:enumeration value="en-GB"/>
<xs:enumeration value="en-AU"/>
<xs:enumeration value="fr-FR"/>
<xs:enumeration value="es-ES"/>
<xs:enumeration value="de-DE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="charactersetType">
<xs:restriction base="xs:string">
<xs:enumeration value="GSM"/>
<xs:enumeration value="Unicode"/>
<xs:enumeration value="Auto"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="typeType">
<xs:restriction base="xs:string">
<xs:enumeration value="SMS"/>
<xs:enumeration value="Voice"/>
</xs:restriction>
</xs:simpleType>
<xs:element name="messages">
<xs:complexType>
<xs:sequence>
<xs:element name="accountreference" type="xs:string" minOccurs="1" maxOccurs="1"/>
<xs:element name="from" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="type" type="typeType" minOccurs="0" maxOccurs="1"/>
<xs:element name="retries" type="xs:integer" minOccurs="0" maxOccurs="1"/>
<xs:element name="validity" type="xs:integer" minOccurs="0" maxOccurs="1"/>
<xs:element name="sendat" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="characterset" type="charactersetType" minOccurs="0" maxOccurs="1"/>
<xs:element name="message" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="to" type="xs:string" minOccurs="1" maxOccurs="1"/>
<xs:element name="type" type="typeType" minOccurs="0" maxOccurs="1"/>
<xs:element name="body" type="xs:string" minOccurs="1" maxOccurs="1"/>
<xs:element name="lang" type="langType" minOccurs="0" maxOccurs="1"/>
<xs:element name="retries" type="xs:integer" minOccurs="0" maxOccurs="1"/>
<xs:element name="validity" type="xs:integer" minOccurs="0" maxOccurs="1"/>
<xs:element name="characterset" type="charactersetType" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Example:<?xml version='1.0' encoding='UTF-8'?>
<messages>
<accountreference>EX0000000</accountreference>
<message>
<to>447700900123</to>
<body>Every message matters!</body>
</message>
</messages>
HTTP status code 200
Body
Type: application/xml
Example:<?xml version="1.0" encoding="utf-8"?>
<messageheaders batchid="F8BF9867-FF81-49E4-ACC5-774DE793B776"
xmlns="http://api.esendex.com/ns/">
<messageheader uri="https://api.esendex.com/v1.0/messageheaders/1183C73D-2E62-4F60-B610-30F160BDFBD5" id="1183C73D-2E62-4F60-B610-30F160BDFBD5" />
</messageheaders>