API Overview

DLangEmobile web API uses REST interface to send and retrieve data. Native HTTP methods such as GET, POST, PUT and DELETE are exposed and data are exchanged as XML document. The service expects all texts to be UTF-8 encoded.

This is a sample XML response:

<Message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Content>sample</Content>
<PhoneNumbers><string>1111111111</string>
</PhoneNumbers>
</Message>

You will receive the following XML response if there's an error. Error message includes the error code and message.

<ErrorResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<ErrorCode>103</ErrorCode>
<ErrorMessage>Contact not found. Please provide a valid Contact ID.</ErrorMessage>
</ErrorResponse>

Below are the available methods, separated by the main data entities:

Billing

account

https://appapi.dlangemobile.com/xml/billing/{api_key}/account [GET] - Retrieve account information.

inbox

https://appapi.dlangemobile.com/xml/billing/{api_key}/inbox [GET] - Retrieve inbox messages for billing.

outbox

https://appapi.dlangemobile.com/xml/billing/{api_key}/outbox [GET] - Retrieve outbox messages for billing.

reseller groups

https://appapi.dlangemobile.com/xml/billing/{api_key}/resellergroups [GET] - Retrieve groups and subgroups information for resellers.

SMS/MMS Contacts

contact info

https://appapi.dlangemobile.com/xml/contacts/{api_key} [GET, POST] - Retrieve all contacts and add new contact.
https://appapi.dlangemobile.com/xml/contacts/{api_key}/{contact_id} [GET, PUT, DELETE] - Retrieve contact, update contact info, delete contact, opt-in or opt-out a contact.
https://appapi.dlangemobile.com/xml/contacts/{api_key}/optedout [GET] - Retrieve opted out contacts.

contact groups

https://appapi.dlangemobile.com/xml/contacts/{api_key}/{contact_id}/groups [GET] - Retrieve all groups for specified contact.
https://appapi.dlangemobile.com/xml/contacts/{api_key}/{contact_id}/groups/{group_id} [PUT, DELETE] - Assign group and delete group for specified contact.

SMS/MMS Groups

group info

https://appapi.dlangemobile.com/xml/groups/{api_key} [GET, POST] - Retrieve all groups and add new group.
https://appapi.dlangemobile.com/xml/groups/{api_key}/{group_id} [GET, PUT, DELETE] - Retrieve group, update group info and delete group.

group contacts

https://appapi.dlangemobile.com/xml/groups/{api_key}/{group_id}/contacts [GET] - Retrieve all contacts for specified group.
https://appapi.dlangemobile.com/xml/groups/{api_key}/{group_id}/contacts/{contact_id} [PUT, DELETE] - Assign contact and delete contact for specified group.

SMS/MMS Messaging

send message

https://appapi.dlangemobile.com/xml/messages/{api_key}/longcode [GET, POST] - Send long-code message; retrieve footer and maximum number of characters allowed.
https://appapi.dlangemobile.com/xml/messages/{api_key}/shortcode [GET, POST] - Send short-code message; retrieve maximum number of characters allowed.

inbox

https://appapi.dlangemobile.com/xml/messages/{api_key}/inbox [GET] - Retrieve inbox messages and total inbox messages count.
https://appapi.dlangemobile.com/xml/messages/{api_key}/inbox/{message_id} [GET, PUT, DELETE] - Retrieve message, set as read/unread, restore and delete message.

outbox

https://appapi.dlangemobile.com/xml/messages/{api_key}/outbox [GET] - Retrieve outbox messages and total outbox messages count.
https://appapi.dlangemobile.com/xml/messages/{api_key}/outbox/{message_id} [GET] - Retrieve message.

sent messages

https://appapi.dlangemobile.com/xml/messages/{api_key}/sent [GET] - Retrieve sent messages and total sent messages count.
https://appapi.dlangemobile.com/xml/messages/{api_key}/sent/{message_id} [GET, PUT, DELETE] - Retrieve message, set as read/unread, restore and delete message.

failed messages

https://appapi.dlangemobile.com/xml/messages/{api_key}/failed [GET] - Retrieve failed messages and total sent messages count.

Email Contacts

contact info

https://appapi.dlangemobile.com/xml/emailcontacts/{api_key} [GET, POST] - Retrieve all contacts and add new contact.
https://appapi.dlangemobile.com/xml/emailcontacts/{api_key}/{contact_id} [GET, PUT, DELETE] - Retrieve contact, update contact info and delete contact.

contact groups

https://appapi.dlangemobile.com/xml/emailcontacts/{api_key}/{contact_id}/groups [GET] - Retrieve all groups for specified contact.
https://appapi.dlangemobile.com/xml/emailcontacts/{api_key}/{contact_id}/groups/{group_id} [PUT, DELETE] - Assign group and delete group for specified contact.

Email Groups

group info

https://appapi.dlangemobile.com/xml/emailgroups/{api_key} [GET, POST] - Retrieve all groups and add new group.
https://appapi.dlangemobile.com/xml/emailgroups/{api_key}/{group_id} [GET, PUT, DELETE] - Retrieve group, update group info and delete group.

group contacts

https://appapi.dlangemobile.com/xml/emailgroups/{api_key}/{group_id}/contacts [GET] - Retrieve all contacts for specified group.
https://appapi.dlangemobile.com/xml/emailgroups/{api_key}/{group_id}/contacts/{contact_id} [PUT, DELETE] - Assign contact and delete contact for specified group.

Email Messaging

send message

https://appapi.dlangemobile.com/xml/email/{api_key}/send [POST] - Send email messages.

outbox

https://appapi.dlangemobile.com/xml/email/{api_key}/outbox [GET] - Retrieve outbox messages and total outbox messages count.
https://appapi.dlangemobile.com/xml/email/{api_key}/outbox/{message_id} [GET] - Retrieve message.

sent messages

https://appapi.dlangemobile.com/xml/email/{api_key}/sent [GET] - Retrieve sent messages and total sent messages count.
https://appapi.dlangemobile.com/xml/email/{api_key}/sent/{message_id} [GET] - Retrieve sent message.

failed messages

https://appapi.dlangemobile.com/xml/email/{api_key}/failed [GET] - Retrieve failed messages and total failed messages count.