You are here: Home Page Documentation API

Summary

The purpose of the XendApp API is that you should be able to automate your sending of messages to the XendApp Clients.


.NET

There are many ways to utilize the API in .NET. We have created a c# assembly which you can easily reference in your project.

You can download this here.


Other languages

If you have written samples of how to use our service in other languages we would be happy to post them online - please contact us.


Our web services

Our web services for sending messages and retrieving information supports the following formats; JSON, XML, REST GET. See services below.



Uri template: https://xendapp.com/MessageService/SendMessage?username={userName}&password={password}
Publishes specified message to channel with POST method. Request should be in XML format.
Parameters:
  • username - sender's username. (string)
  • password - sender's password. (string)
  • message - XML containing message information(string). XML fields are:
    • S - Base64-encoded subject (string).
    • B - Base64-encoded message (string).
    • CI - channel identificator (guid).
    • CTI - content type (can be 1 or 2) (int). 1 - PlainText, 2 - HTML.
    • E - expiry date (UNIX timestamp format) (long). If set to 0, then by default equals to current date + 3 months.
    • EC - flag indicating if message should be encrypted or not (bool)
    Below is an example XML:

    <MTS xmlns="http://schemas.datacontract.org/2004/07/Xend.Business.CompositeTypes">
    <S>TWVzc2FnZSBzdWJqZWN0</S>
    <B>TWVzc2FnZSBib2R5</B>
    <CI>1627aea5-8e0a-4371-9022-9b504344e724</CI>
    <CTI>1</CTI>
    <E>922337203</E>
    <EC>true</EC>
    </MTS>
Returns created message identificator (guid) in XML format.
Uri template: https://xendapp.com/MessageService/SendPlainTextMessage?username={userName}&password={password}
Publishes specified message to channel with POST method. Request should be in XML format.
Parameters:
  • username - sender's username. (string)
  • password - sender's password. (string)
  • message - XML containing message information (string). XML fields are:
    • S - plain text subject (string).
    • B - plain text message (string).
    • CI - channel identificator (guid).
    • CTI - content type (can be 1 or 2) (int). 1 - PlainText, 2 - HTML.
    • E - expiry date (UNIX timestamp format) (long). If it set to 0, then by default equals to current date + 3 months.
    • EC - flag indicating if message is encrypted or not (bool)
    Below is an example XML:

    <MTS xmlns="http://schemas.datacontract.org/2004/07/Xend.Business.CompositeTypes">
    <S>Message subject</S>
    <B>Message body</B>
    <CI>1627aea5-8e0a-4371-9022-9b504344e724</CI>
    <CTI>1</CTI>
    <E>922337203</E>
    <EC>true</EC>
    </MTS>
Returns created message identificator (guid) in XML format.
Uri template: https://xendapp.com/MessageService/SendPlainTextMessageJson?username={userName}&password={password}
Publishes specified message to channel with POST method. Request should be in JSON format.
Parameters:
  • username - sender's username. (string)
  • password - sender's password. (string)
  • message - JSON containing message information (string). JSON fields are:
    • S - plain text subject (string).
    • B - plain text message (string).
    • CI - channel identificator (guid).
    • CTI - content type (can be 1 or 2) (int). 1 - PlainText, 2 - HTML.
    • E - expiry date (UNIX timestamp format) (long). If it set to 0, then by default equals to current date + 3 months.
    • EC - flag indicating if message is encrypted or not (bool)
    Below is an example JSON:

    {
    "S":"Message subject",
    "B":"Message body",
    "CI":"1627aea5-8e0a-4371-9022-9b504344e724",
    "CTI":2147483647,
    "E":9223372036854775807,
    "EC":true
    }
Returns created message identificator (guid) in JSON format.

© 2012 XendApp. All rights reserved

We are social: