Skip to end of metadata
Go to start of metadata

Last Updated: Friday, January 26, 2018



GET - /MessageApi/mt/messages/<messageId>

Get information about a previous Mobile Terminated (MT) submission. The purpose of the call is for information or troubleshooting on a single message.

Note: 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. Additionally, performance on this call is more intensive than other calls, and should be used only to retrieve a specific message for informational purposes. 
Caution: This API should not be used for mass message data retrieval. If information is needed on multiple MT message status, please see Callback Services for inline processing.

URL Request Example

https://messageapi.vibesapps.com/MessageApi/mt/messages/b75fccf3-8f06-4d8f-a282-d1886a4792a2

Successful XML Response Example

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

 

 fwdToMessageIdIf a message utilizes an Alternate 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. 
 fwdFromMessageIdIf a message utilizes an Alternate 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

 noOfPartsFor a message that isMultipart=true, indicates the number of parts for the message. Only present if isMultipart=true.String
 partNumberFor a message that isMultipart=true, indicates which part this particular message is. Only present if isMultipart=true.String
 originalMessageIdFor a message that isMultipart=true, indicates the messageId for the original message that was split. Only present if isMultipart=true.String


 
  • No labels