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="true" noOfParts="2" partNumber="1" originalMessageId="b75fccf3-8f06-4d8f-a282-d1886a4792a2"> <destination carrier="102" address="+12995551234" type="MDN" /> <source address="98765" type="SC" /> <text>123857AB12</text> <receiptOption>ERROR</receiptOption> </mtMessage>
Response Element Descriptions
Element | Attribute Name | Description | Data Type |
---|---|---|---|
mtMessage |
| The main wrapper element around the submit response. |
|
fwdToMessageId | If a message utilizes anAlternate Message Delivery, this attribute will show up on callbacks for the original message and the value will be the identifier of the message forwarded on the alternate source address. | ||
fwdFromMessageId | If a message utilizes anAlternate Message Delivery, this attribute will show up on callbacks for the forwarded message and the value will be the identifier of the original message submitted to the API. | ||
isMultipart | Only present if equal to True. True if this message is part of a multi-part message. | Boolean | |
noOfParts | For a message that isMultipart=true, indicates the number of parts for the message. Only present if isMultipart=true. | String | |
partNumber | For a message that isMultipart=true, indicates which part this particular message is. Only present if isMultipart=true. | String | |
originalMessageId | For a message that isMultipart=true, indicates the messageId for the original message that was split. Only present if isMultipart=true. | String |
Overview
Content Tools