//[[restapi:start|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 [[:mmc_otto|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. <wrap info>A formatted date string: **dd-MM-yyyy** \\ For more information please review the [[restapi:appx_date|pattern letters]] quick reference</wrap> |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[:mmc_otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|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 [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<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>

</code>

== 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 [[:mmc_otto|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 | <wrap info>A formatted date string: **dd-MM-yyyy** \\ For more information please review the [[restapi:appx_date|pattern letters]] quick reference</wrap> |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[:mmc_otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|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 [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<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>

</code>

== 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.

<WRAP round notice>
Please, for high traffic codes use short time intervals.
</WRAP>

==== 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 [[:mmc_otto|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. <wrap info>A formatted date string: **dd-MM-yyyy** \\ For more information please review the [[restapi:appx_date|pattern letters]] quick reference</wrap> |
| finalDate | Desired end date: <wrap info>A formatted date string: **dd-MM-yyyy** \\ For more information please review the [[restapi:appx_date|pattern letters]] quick reference</wrap> |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[:mmc_otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|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 [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<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>

</code>

== 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 [[restapi:appx_date|pattern letters]] quick reference |
| mt.timezone | Timezone used | Text |
| mt.status | The message status | See our [[restapi:appx_msg_status#sms|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 [[restapi:appx_date|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.

<WRAP round notice>
Please, for high traffic codes use short time intervals.
</WRAP>

==== 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 [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| initialDate | Desired start date. <wrap info>A formatted date string: **dd-MM-yyyy** \\ For more information please review the [[restapi:appx_date|pattern letters]] quick reference</wrap> |
| finalDate | Desired end date: <wrap info>A formatted date string: **dd-MM-yyyy** \\ For more information please review the [[restapi:appx_date|pattern letters]] quick reference</wrap> |
| filters \\ <wrap notice>OPTIONAL</wrap> | 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 [[restapi:appx_mt_search|MT Inline Search String]] appendix. <wrap info>Write **null** on this placeholder if you don't want to use search filters </wrap> | 
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|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 [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<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>

</code>

== 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 [[restapi:appx_date|pattern letters]] quick reference |
| mt.timezone | Timezone used | Text |
| mt.status | The message status | See our [[restapi:appx_msg_status#sms|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 [[restapi:appx_date|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 [[:mmc_otto|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 [[:mmc_otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|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 [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<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>

</code>

== 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 [[:mmc_otto|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 [[restapi:campaigns#list_campaigns|List Campaigns]] |
| initialDate \\ <wrap notice>OPTIONAL</wrap> | The start date to use. \\ <wrap info>A formatted date string: **dd-MM-yyyy** For more information please review the [[restapi:appx_date|pattern letters]] quick reference </wrap> \\ <wrap info>Use **null** to ignore this parameter</wrap>  |
| finalDate \\ <wrap notice>OPTIONAL</wrap> | The end date to use. \\ <wrap info>A formatted date string: **dd-MM-yyyy** For more information please review the [[restapi:appx_date|pattern letters]] quick reference </wrap> \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| text \\ <wrap notice>OPTIONAL</wrap> | The Desired text \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| mobileNumber \\ <wrap notice>OPTIONAL</wrap> | The desired mobile number \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| carrierId \\ <wrap notice>OPTIONAL</wrap> | The desired carrier ID \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[:mmc_otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|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 [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<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>

</code>

== 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 [[:mmc_otto|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 \\ <wrap notice>OPTIONAL</wrap> | The start date to use. \\ <wrap info>A formatted date string: **dd-MM-yyyy** For more information please review the [[restapi:appx_date|pattern letters]] quick reference </wrap> \\ <wrap info>Use **null** to ignore this parameter</wrap>  |
| finalDate \\ <wrap notice>OPTIONAL</wrap> | The end date to use. \\ <wrap info>A formatted date string: **dd-MM-yyyy** For more information please review the [[restapi:appx_date|pattern letters]] quick reference </wrap> \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| campaignName \\ <wrap notice>OPTIONAL</wrap> | Desired campaign name \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| text \\ <wrap notice>OPTIONAL</wrap> | The Desired text \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| mobileNumber \\ <wrap notice>OPTIONAL</wrap> | The desired mobile number \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[:mmc_otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|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 [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<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>

</code>

== 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 |