RESTful API

Weekly Global Report

Overview

Returns a weekly report for the given user.

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/getWeekReport/{instanceId}/{userName}/{date}/{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
userName The user name of the campaign's owner
date The initial week day. A formatted date string: dd-MM-yyyy
For more information please review the pattern letters quick reference
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>getWeekReport</input>
<status>OK</status>
<description>Completed</description>
<result>
	<weekreport>
		<sunday>0</sunday>
        	<monday>1</monday>
		<tuesday>1</tuesday>
		<wednesday>1</wednesday>
		<thursday>1</thursday>
		<friday>1</friday>
		<saturday>1</saturday>
		<total>6</total>
	</weekreport>
</result>
Result parameters
Parameter Name Description Possible Values
weekreport.sunday Number of messages received for the campaign on Sunday Number
weekreport.monday Number of messages received for the campaign on Monday Number
weekreport.tuesday Number of messages received for the campaign on Tuesday Number
weekreport.wednesday Number of messages received for the campaign on Wednesday Number
weekreport.thursday Number of messages received for the campaign on Thursday Number
weekreport.friday Number of messages received for the campaign on Friday Number
weekreport.saturday Number of messages received for the campaign on Saturday Number
weekreport.total Number of messages received for the campaign the whole week Number

Product Report

Overview

Returns the amount of messages by label and carrier for the given campaign

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/getCampaignReport/{instanceId}/{mimId}/{date}/{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
mimId campaign ID, you can retrieve this information directly from the Campaign Manager
date A formatted date string: dd-MM-yyyy
For more information please review the pattern letters quick reference
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>getCampaignReport</input>
<status>OK</status>
<description>Completed</description>
<result>
    <productreport>
	<carriernames>AT&T</carriernames>
 
        ...
 
	<carriernames>T-Mobile</carriernames>
	<labelreports>
		<name>demo label 1</name>
		<carrierreports>
			<carrierId>1</carrierId>
			<totalMsg>0</totalMsg>
		</carrierreports>
 
                ...
 
		<carrierreports>
			<carrierId>2</carrierId>
			<totalMsg>3</totalMsg>
		</carrierreports>
		<percentage>50.0</percentage>
		<totalmsg>3</totalmsg>
	</labelreports>
 
        ...
 
	<labelreports>
		<name>demo label 2</name>
		<carrierreports>
			<carrierId>1</carrierId>
			<totalMsg>2</totalMsg>
		</carrierreports>
 
                ...
 
		<carrierreports>
			<carrierId>2</carrierId>
			<totalMsg>1</totalMsg>
		</carrierreports>
		<percentage>50.0</percentage>
		<totalmsg>3</totalmsg>
	</labelreports>
   </productreport>
</result>
Result parameters
Parameter Name Description Possible Values
carriernames Name the carrier Text
labelreports.name Name label reports Text
labelreports.carrierreports.carrierId Id Carrier Number
labelreports.carrierreports.totalMsg Total of messages sent by a carrier Number
labelreports.percentage Percentage Number
labelreports.totalmsg Total of messages sent Number

MT Report

Overview

List all MT traffic for a given code and a period of time.

Please, for high traffic codes use short time intervals.

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/getMTsReport/{instanceId}/{shortcode}/{initialDate}/{finalDate}/{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
shortcode The desired short/long code
initialDate Desired start date. A formatted date string: dd-MM-yyyy
For more information please review the pattern letters quick reference
finalDate Desired end date: A formatted date string: dd-MM-yyyy
For more information please review the pattern letters quick reference
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>getMTsReport</input>
<status>OK</status>
<description>Completed</description>
<result>
	<mts>
    		<mt>
			<id></id>
			<operator></operator>
			<from></from>
			<to></to>
			<sendedOn></sendedOn>
			<timezone></timezone>
			<status></status>
			<statusOn></statusOn>
			<text></text>
    		</mt>
 
		...
 
		<mt>
			<id></id>
			<operator></operator>
			<from></from>
			<to></to>
			<sendedOn></sendedOn>
			<timezone></timezone>
			<status></status>
			<statusOn></statusOn>
			<text></text>
    		</mt>
	</mts>
</result>
Result parameters
Parameter Name Description Possible Values
mt.id Message ID Number
mt.operator The (short/long) code mobile operator Text
mt.from The user mobile number who originated the message Number
mt.to The destination code Number
mt.sendedOn Time mark at the reception time A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
mt.timezone Timezone used Text
mt.status The message status See our Message's Status page
mt.statusOn Time mark for the last status update A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
mt.text The message content Text

MT Report with Filters

Overview

List all MT traffic on a period of time, can be filtered by several attributes.

Please, for high traffic codes use short time intervals.

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/getMTsReportFiltered/{instanceId}/{initialDate}/{finalDate}/{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 Desired start date. A formatted date string: dd-MM-yyyy
For more information please review the pattern letters quick reference
finalDate Desired end date: A formatted date string: dd-MM-yyyy
For more information please review the pattern letters quick reference
filters
OPTIONAL 		This parameter allows filtering by origin, destination, blast id, carrier or status. Status values are based on Delivery Receipts. Please find more information about these filters in the MT Inline Search String appendix. Write null on this placeholder if you don't want to use search filters
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>getMTsReport</input>
<status>OK</status>
<description>Completed</description>
<result>
	<mts>
    		<mt>
			<id></id>
			<operator></operator>
			<from></from>
			<to></to>
			<sendedOn></sendedOn>
			<timezone></timezone>
			<status></status>
			<statusOn></statusOn>
			<text></text>
                        <blastId>1234</blastId>
    		</mt>
 
		...
 
		<mt>
			<id></id>
			<operator></operator>
			<from></from>
			<to></to>
			<sendedOn></sendedOn>
			<timezone></timezone>
			<status></status>
			<statusOn></statusOn>
			<text></text>
                        <blastId>0</blastId>
    		</mt>
	</mts>
</result>
Result parameters
Parameter Name Description Possible Values
mt.id Message ID Number
mt.operator The (short/long) code mobile operator Text
mt.from The user mobile number who originated the message Number
mt.to The destination code Number
mt.sendedOn Time mark at the reception time A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
mt.timezone Timezone used Text
mt.status The message status See our Message's Status page
mt.statusOn Time mark for the last status update A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
mt.text The message content Text
mt.blastId Id of the broadcast that sent the message. Number

Multiple Choice Statistics

Overview

Returns the current status for a Multiple Choice campaign.

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/getMCStatisticsReport/{instanceId}/{mimId}/{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
mimId The campaign ID. Must be a multiple choice
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>getMCStatisticsReport</input>
<status>OK</status>
<description>Completed</description>
<result>
	<statistics>
		<statistic question=”1” option=”1” hits=”5” share=”50%”>
			<question>The question text</question>
			<option>the option text</option>
		</statistic>
 
	        ...
 
		<statistic question=”2” option=”1” hits=”5” share=”50%”>
			<question>The question text</question>
			<option>the option text</option>
		</statistic>
	</statistics>
</result>
Result parameters
Parameter Name Description Possible Values
statistic.question Current question Text
statistic.option Current Option Text

List Message Report

Overview

List the message traffic for the given campaign.

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/getMessagesCampaign/{instanceId}/{mimId}/{initialDate}/{finalDate}/{text}/{mobileNumber}/{carrierId}/{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
mimId The campaign id, you could retrieve this information from the campaign manager UI or using the List Campaigns
initialDate
OPTIONAL 		The start date to use.
A formatted date string: dd-MM-yyyy For more information please review the pattern letters quick reference
Use null to ignore this parameter
finalDate
OPTIONAL 		The end date to use.
A formatted date string: dd-MM-yyyy For more information please review the pattern letters quick reference
Use null to ignore this parameter
text
OPTIONAL 		The Desired text
Use null to ignore this parameter
mobileNumber
OPTIONAL 		The desired mobile number
Use null to ignore this parameter
carrierId
OPTIONAL 		The desired carrier ID
Use 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>getMessagesCampaign</input>
<status>OK</status>
<description>Completed</description>
<result>
	<messages>
		<message>
			<msisdn>04141111111</msisdn>
			<rspdate>2013-09-05T16:08:52-04:00</rspdate>
			<text>mensaje1</text>
		</message>
		<message>
			<msisdn>1582222222</msisdn>
			<rspdate>2013-09-02T13:08:52-04:00</rspdate>
			<text>mensaje2</text>
		</message>
		<message>
			<msisdn>584123333333</msisdn>
			<rspdate>2013-09-01T19:48:51-04:00</rspdate>
			<text>mensaje3</text>
		</message>
	</messages>
</result>
Result parameters
Parameter Name Description Possible Values
message.msisdn The user mobile number Text
message.rspdate Time mark for the current message Date
message.text The message content Text

List Messages by Code Report

Overview

List messages by short/long code.

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/getMessagesByShortcode/{instanceId}/{shortcode}/{initialDate}/{finalDate}/{campaignName}/{text}/{mobileNumber}/{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
shortcode The desired short/long code
initialDate
OPTIONAL 		The start date to use.
A formatted date string: dd-MM-yyyy For more information please review the pattern letters quick reference
Use null to ignore this parameter
finalDate
OPTIONAL 		The end date to use.
A formatted date string: dd-MM-yyyy For more information please review the pattern letters quick reference
Use null to ignore this parameter
campaignName
OPTIONAL 		Desired campaign name
Use null to ignore this parameter
text
OPTIONAL 		The Desired text
Use null to ignore this parameter
mobileNumber
OPTIONAL 		The desired mobile number
Use 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>getMessagesByShortcode</input>
<status>OK</status>
<description>Completed</description>
<result>
	<messages>
		<message>
			<msisdn>04141111111</msisdn>
			<rspdate>2013-09-05T16:08:52-04:00</rspdate>
			<text>mensaje1</text>
		</message>
		<message>
			<msisdn>1582222222</msisdn>
			<rspdate>2013-09-02T13:08:52-04:00</rspdate>
			<text>mensaje2</text>
		</message>
		<message>
			<msisdn>584123333333</msisdn>
			<rspdate>2013-09-01T19:48:51-04:00</rspdate>
			<text>mensaje3</text>
		</message>
	</messages>
</result>
Result parameters
Parameter Name Description Possible Values
message.msisdn The user mobile number Text
message.rspdate Time mark for the current message Date
message.text The message content Text