This API allows you to get text to screen approved messages to a RSS file format.
- Url: https://mcpn.us/limeApi
- Parameters:
Parameter Name (Case Sensitive)
|
Value |
Description |
Remarks |
ev |
String |
Must be "text2screenRss" |
|
user (mandatory) |
String |
The advertiser’s username that own the text to screen and matches the api_id |
|
api_id (mandatory) |
String |
The advertiser’s api_id that matches the username |
Can be generated from edit profile |
textToScreenId (mandatory) |
Number |
The Text to screen Id |
|
Return Code:
- If the API succeeds then it will return with status code 200.
- If an error occurs or there is an invalid parameter then it returns with status code 400 or 500 with an error message in the response.
Return Data:
- The return data is an XML file with the approved messages ordered by last is first.
Here is the elements description:
<title> - Text to screen's title
<link>- Link to the Text to screen display mode
<description> - Text to screen's name
<language> - The file language - always "en-us"
<lastBuildDate> - The dateand time this file is built - GMT Time zone
<item>
<title> - The short name of the mobile sender if we have it's name then it will be his first name otherwise it will contains the last 4 digits of his mobile number
<category> Contains the full mobile number
<description> - contains the message
<guid> - Contains a unique id for this item
<pubDate> - when this message arrived
</item>
Example:
<?xml version="1.0" ?>
<rss version="2.0">
<channel>
<title>Free t-shirt</title>
<link>http://bit.ly/xxxxx</link>
<description>Tshirt List</description>
<language>en-us</language>
<lastBuildDate>Thu, 13 Jun 2013 13:55:12 GMT</lastBuildDate>
<item>
<title>Jhone</title>
<category>15555555555</category>
<description><![CDATA[Happy birthday]]></description>
<guid>26432</guid>
<pubDate>Fri, 08 Jun 2012 02:41:20 GMT</pubDate>
</item>
<item>
<title>5551</title>
<category>15555555551</category>
<description><![CDATA[Thank you all]]></description>
<guid>25342</guid>
<pubDate>Fri, 08 Jun 2012 02:30:59 GMT</pubDate>
</item>
</channel>
</rss>
Example:
https://mcpn.us/limeApi?ev=optin&user=advertiser@gmpizza.com&api_id=q5JA73WRLy13822c&keyword=pizza&mobile=15555555555
Comments
0 comments
Article is closed for comments.