//[[restapi:start|RESTful API]]//

====== Retrieving a Message ======

==== Overview ====

Retrieve a message by its Id.

==== URL ====

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/tools/getMessage/{instanceId}/{messageId}/{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// |
| messageId | The message's identifier |
| 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>getMessage</input>
<status>OK</status>
<description>Completed</description>
<result>
	<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>
		<timezone>America/Caracas</timezone>
		<clientId>As223sdadq8d8287v5v</clientId>
		<appName>Inbox</appName>
		<platform>IOS</platform>
	</message>
</result>

</code>

== Result parameters ==

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

^ 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 [[restapi:appx_msg_status#blast|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 [[restapi:appx_date|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 |

====== Update a Message's status ======

==== Overview ====

Update the message's status, this method is used mostly by the App.

==== URL ====

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/tools/updateMessageStatus/{instanceId}/{messageId}/{status}/{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// |
| messageId | The message's identifier |
| status | The new message's status <wrap info>See our valid [[restapi:appx_msg_status#blast|Message's Status]]</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>registerFacebookApp</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>

</code>

== Result parameters ==

^ Parameter Name ^ Description ^ Possible Values ^
| successful | Indicates if the status was updated correctly | <color blue>true</color> \\ <color red>false</color> |
| message | A human readable explanation | Text |