RESTful API

Message Report

Overview

List all messages information in a given period of time. It support filters to help you get the desired information easily.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/messageReport/{instanceId}/{initialDate}/{finalDate}/{page}/{resultsPerPage}/{parameters}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
initialDate Starting timestamp Measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
finalDate Final timestamp Measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
page This is a paginated method, so please use page to indicate the actual page you want to retrieve.
resultsPerPage How many results to show per page. Note that this will affect the total amount of pages
parameters This parameters are special filters to narrow results when dealing with big amounts of data, Please find more information about these filters in the MT Inline Search String appendix
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>messageReport</input>
<status>OK</status>
<description>Completed</description>
<result>
	<messages>
		<records>15</records>
		<message>
			<blastId>-2490820026197535447</blastId>
			<id>2758ebc5-1db5-4822-a5ed-36121e0674a6</id>
			<type>PUSH</type>
			<from>Inbox</from>
			<to>18133210984</to>
			<subject>Inbox Push Ogangi</subject>
			<text>Inbox Push Ogangi Message</text>
			<status>SENT</status>
			<statusDescription>Sent</statusDescription>
			<date>2014-01-24T12:45:50.903-04:30</date>
			<lastUpdated>2015-11-04T11:47:26.511-04:30</lastUpdated>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
			<appName>Inbox</appName>
			<platform>IOS</platform>
		</message>
 
		...
 
	</messages>
</result>
Result parameters

Please be aware that the <message> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name Description Possible Values
message.blastId Unique identifier for the blast used to fire the message Text
message.id Unique identifier for the message created Text
message.type Indicates the kind of message that was sent PUSH
SMS
EMAIL
message.from Who sent the message for PUSH, Application that sent the message
for SMS, Short/Long code which originated the message
for EMAIL, the email address which sent the message.
message.to Recipient for this message Any of the following:
deviceId
mobile number
email address
message.subject Message's subject Text
message.text Message's content Text
message.status Indicates the message's status at the origination moment See our Message's Status page
message.statusDescription A human readable explanation about the current status Text
message.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
message. lastUpdated The date when message's status changed. A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
message.timezone Timezone used Text
message.clientId The client identification (sender) Text
message.appName App used, only available when using PUSH Text
message.platform App platform, only available when using PUSH Text

Blast Report

Overview

List all blast information for in a given period of time. It support basic filters to help you get the desired information easily.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/blastReport/{instanceId}/{initialDate}/{finalDate}/{parameters}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
initialDate Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
finalDate Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
parameters This parameters are special filters to narrow results when dealing with big amounts of data, Please find more information about these filters in the Blast Inline Search String appendix
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>blastReport</input>
<status>OK</status>
<description>Completed</description>
<result>
	<blasts>
		<records>2</records>
		<blast>
			<blastId>8893564166207748459</blastId>
			<status>FINISHED</status>
			<sending>0</sending>
			<sent>0</sent>
			<read>0</read>
			<bounced>0</bounced>
			<complained>0</complained>
		<blast>
 
		...
 
	</blasts>
</result>
Result parameters

Please be aware that the <blast> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name Description Possible Values
blast.blastId Unique identifier for the blast used to fire the message Text
blast.status The current blast's status SCHEDULED, SENDING, FAILED or FINISHED
blast.sending Number of this blast's messages with 'sending' state. Number
blast.sent Number of this blast's messages with 'sent' state. Number
blast.read Number of this blast's messages with 'read' state. Number
blast.bounced Number of this blast's messages with 'bounced' state. Number
blast.complained Number of this blast's messages with 'complained' state. Number

Scratch Card Report

Overview

List all Scratch Cards information configured for a given period of time.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/scratchCardReport/{instanceId}/{initialDate}/{finalDate}/{parameter}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
initialDate Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
finalDate Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
parameter The only search parameter permitted is EXTERNAL_ID. Ex: EXTERNAL_ID=CampaignName will only show results with that EXTERNAL_ID. Write null to ignore this parameter
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>scratchCardReport</input>
<status>OK</status>
<description>Completed</description>
<result>
	<scratchCardReport>
		<records>2</records>
		<scratchCardReportList>
			<scratchCardReportItem>
				<externalId>Demo</externalId>
				<totalSent>11</totalSent>
				<totalVisit>10</totalVisit>
				<clientDate>2015-10-20T17:23:58.749-04:30</clientDate>
				<timezone>America/New_York</timezone>
			</scratchCardReportItem>
			<scratchCardReportItem>
				<externalId>Demo2</externalId>
				<totalSent>5</totalSent>
				<totalVisit>1</totalVisit>
				<clientDate>2015-10-21T17:23:58.749-04:30</clientDate>
				<timezone>America/New_York</timezone>
			</scratchCardReportItem>
		</scratchCardReportList>
	</scratchCardReport>
</result>
Result parameters
Parameter Name Description Possible Values
scratchCardReport.records The number of the total records Number
scratchCardReportItem.externalId The externalId of the scratchcard. Text
scratchCardReportItem.totalSent The number of times that a scratchcard has been sent. Number
scratchCardReportItem.totalVisit How many users have seen the scratchcard Number
scratchCardReportItem.clientDate Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
Date
scratchCardReportItem.timezone The scratchcard's timezone. Text

URLs Redirect's Report

Overview

Retrieve and review all statistic information about all redirect URL configured for a period of time. Filters are available to help you dealing with big amounts of data.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/redirectUrlReport/{instanceId}/{initialDate}/{finalDate}/{page}{resultsPerPage}/{filters}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
initialDate Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
finalDate Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
page This is a paginated method, so please use page to indicate the actual page you want to retrieve.
resultsPerPage How many results to show per page. Note that this will affect the total amount of pages
filters Use filters to narrow results when dealing with big amounts of data, Please find more information about these filters in the URL Inline Search String appendix
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>redirectUrlReport</input>
<status>OK</status>
<description>Completed</description>
<result>
	<redirectUrlReport>
		<records>2</records>
		<redirectUrlList>
			<url>
				<fullUrl>https://api.messangi.com/rest/message/executeRedirect/d93f7813-l</fullUrl>
				<shortUrl>http://messangi.com/r/d93f7813-l</shortUrl>
				<destinationURL>https://api.messangi.com/messangi-staging/content/scratchcards/cards/783380f4-f2e6-4c81-a21c-1948c657c3101</destinationURL>
				<to>178755052800</to>
				<externalId>CAMPAINGNAME</externalId>
				<clientId>D79BFFVx2TjXcJrrnktB</clientId>
				<visits>1</visits>
				<oneTime>false</oneTime>
				<isActive>true</isActive>
				<clientDate>2015-11-07T09:44:03.327-05:00</clientDate>
			</url>
			<url>
				<fullUrl>https://api.messangi.com/rest/message/executeRedirect/d43ffe13-r</fullUrl>
				<shortUrl>http://messangi.com/r/d43ffe13-r</shortUrl>
				<destinationURL>https://api.messangi.com/messangi-staging/content/scratchcards/cards/7da380f4-f2e6-4c81-w11c-194fe657c3101</destinationURL>
				<to>588754852800</to>
				<externalId>CAMPAINGNAME</externalId>
				<clientId>D79BFFVx2TjXcJrrnktB</clientId>
				<visits>0</visits>
				<oneTime>true</oneTime>
				<isActive>false</isActive>
				<clientDate>2015-11-07T10:44:03.327-05:00</clientDate>
			</url>
		</redirectUrlList>
	</redirectUrlReport>
</result>
Result parameters
Parameter Name Description Possible Values
redirectUrlReport.records Total hits found for this search Number
url.fullUrl The real API URL. URL
url.shortUrl A short version of the URL that uses apache redirects to resolve to the API URL. URL
url.destinationURL URL where you will be redirected. URL
url.to Recipient's mobile number Text
url.externalId Campaign name which belongs Redirect Url. Text
url.clientId The Client´s identifier. Text
url.visits Current visits count for this URL Number
url.oneTime Indicates if the URL is available just 1 time for each user true
false
url.isActive Indicates if the URL is active at the moment true
false
url.clientDate Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference