If the splitlongmessage
attribute was set to True
in your request, your message may have been split into multiple parts to deliver to the end user. In this case, you can get information about each of the parts by adding /parts
to the end of your URL request.
Request
This call will retrieve information about a specific message that you previous sent to a mobile device. To perform this call, you’ll need the specific messageID
for the message you’d like information on. The messageID is returned when you successfully submit a message.
https://messageapi.vibesapps.com/MessageApi/mt/messages/b75fccf3-8f06-4d8f-a282-d1886a4792a2/parts
Response
Below is an example of a response you might get when requesting this message’s parts. The relevant elements are highlighted in yellow, and description of each element is below. For more information about the other elements and attributes not defined here, see send an SMS.
<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>
<mtMessage submitterMessageId="239487234987234" messageId="j48dhf93-8f06-4d8f-a282-d1886a4792a2"
submitDate="2011-04-19T15:10:08.320-05:00" isMultipart="true" noOfParts="2" partNumber="2" 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>
</mtMessageParts>
mtMessage
This is the main wrapper element for each part of the response. The mtMessageParts
element will surround this element and its attributes.
Attribute Name | Description | Data Type |
---|---|---|
isMultipart | If the original message was multipart, this will be set to true . | Boolean |
noOfParts | The total number of parts the original message got split into. | String |
partNumber | The numerical order of this message. For example, the first message sent will be 1, the second will be 2, and so on. | String |
originalMessageId | If the request’s message was split into multiple parts and this is not the original message, this will display the messageID of the first part of the message. | String |