getMtMessage - Retrieve a previous MT Message
GET - /MessageApi/mt/messages/<messageId>
Get information about a previous MT submission. Please note that due to the asynchronous processing of the system, the message is not guaranteed to be available and its status retrievable until after the Response callback has been made.
Sample URL Request
https://messageapi.vibesapps.com/MessageApi/mt/messages/b75fccf3-8f06-4d8f-a282-d1886a4792a2
Successful XML Response
<mtMessage submitterMessageId="239487234987234" messageId="b75fccf3-8f06-4d8f-a282-d1886a4792a2" submitDate="2011-04-19T15:10:08.320-05:00" isMultipart="false" noOfParts=2 partNumber=1 masterMessageUid="b75fccf3-8f06-4d8f-a282-d1886a4792a2"> <destination carrier="102" address="+12995551234" type="MDN" /> <source address="98765" type="SC" /> <text>123857AB12</text> <receiptOption>ERROR</receiptOption> </mtMessage>
Note: isMultipart, noOfParts, partNumber,masterMessageUid attributes are optional and would only be present if splitLongMessage attribute in original request is set to be true and message got split into multiple parts.
Response Element Descriptions
Element | Attribute Name | Description | Data Type |
---|---|---|---|
mtMessage |
| The main wrapper element around the submit request. |
|
| isMultipart | True if the original Long message got split into multiple parts and original request had splitLongMessage set to True | Boolean |
noOfParts | if the original Long message got split into multiple parts and original request had splitLongMessage set to True, it's the total number of parts original message got split into | Number | |
partNumber | if the original Long message got split into multiple parts and original request had splitLongMessage set to True, it's the reference part number for current part of the long message | Number | |
masterMessageUid | if the original Long message got split into multiple parts and original request had splitLongMessage set to True, it's original (first part) messageUid | String |
Overview
Content Tools