Skip to end of metadata
Go to start of metadata

Last Updated: Friday, January 26, 2018



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

Get a summary of all of the responses received from for a particular Mobile Terminated (MT) message at the various stages of processing.

Success Response Example

<?xml version="1.0" encoding="UTF-8"?>
<mtMessageResponses>
	<mtMessageResponse messageId="865cd3d1-bea6-4a6f-8bac-bae483248a27"    
		submitterMessageId="afbcc29f-7d2f-480f-9f5d-d961a2a864e3"     
		receiptDate="2011-05-16T15:48:08.515-05:00">   
		<multipart isMultipart="true" originalMessageId="865cd3d1-bea6-4a6f-8bac-bae483248a27" noOfParts="2" partNumber="1" />  
		<type>Carrier</type>    
		<status isError="false">        
			<description>MtMessage successfully delivered to Carrier</description>       
		</status>
	</mtMessageResponse>
        <mtMessageResponse messageId="865cd3d1-bea6-4a6f-8bac-bae483248a27"    
		submitterMessageId="afbcc29f-7d2f-480f-9f5d-d961a2a864e3"     
		receiptDate="2011-05-16T15:48:23.520-05:00">  
		<multipart isMultipart="true" originalMessageId="865cd3d1-bea6-4a6f-8bac-bae483248a27" noOfParts="2" partNumber="1" />     
		<type>Handset</type>    
		<status isError="true">        
			<description>Carrier failed while submitting message</description>
			<errorCode>107</errorCode>
			<internalErrorCode>7</internalErrorCode>
		</status>
	</mtMessageResponse>
</mtMessageResponses>

Attribute Descriptions

Element

Attribute

Description

Data Type

Required

Default

mtMessageResponses

 

The wrapper element that has all the MtMessageResponses for the MT message.

 

yes

 

mtMessageResponse

 

The root element of a MtMessageResponse.

 

no

 

 

messageId

The unique identifier assigned to the MtMessage when it was submitted.

String

Yes

 

 

submitterMessageId

The client-defined identifier for the MtMessage if set while submitting the message. 

String

No

 

 fwdToMessageIdIf a message utilizes an Alternate Message Delivery, this attribute will show up 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 for the forwarded message, and the value will be the identifier of the original message submitted to the Application Program Interface (API).   

 

receiptDate

Date the response was received in standard XML format.

String

Yes

 

type

 

The processing stage at which the response was generated. The possible values are as follows:

  • System: While the MtMessage was being routed to the carrier by the Message API system.
  • Carrier: While submitting the MtMessage to the carrier.
  • Handset: While submitting the MtMessage to the handset.

String

Yes

 

status

 

Element that has the status of the MtMessage.

 

Yes

 

 

isError

Boolean on whether the status is an error.

Boolean

Yes

 

description

 

Description of the status.

String

Yes

 

errorCode

 

If the message fails, this element contains the error code (Vibes, Carrier MT or Carrier Delivery Receipt) that describes the specific failure reason.
See Appendix B - Error Codes for getMessageResponses for more info.

Numeric

No

 

internalErrorCode

 

If the message fails due to a Vibes error, this element contains the exact same value as the errorCode element.
If the message fails due to a carrier error, this element contains the exact error code returned by the carrier to Vibes for further research. This value can be communicated to Vibes support for more information.
 

Numeric

No

 

multipart
 

The wrapper element that has all information about multipart (long message split into multiple parts) message.

This element is present if the request had splitLongMessage set to True, and the original Long message got split into multiple parts.

   
 
isMultipart

Set to True if the request had splitLongMessage set to True, and the original Long message got split into multiple parts.

Boolean

  
 noOfPartsIf the request had splitLongMessage set to True, and the original Long message got split into multiple parts, it's the total number of parts the original message got split into.String  
 partNumberIf the request had splitLongMessage set to True, and the original Long message got split into multiple parts, it's the reference part number for the current part of the long message.String  
 
originalMessageId
If the request had splitLongMessage set to True, and the original Long message got split into multiple parts, it's the original (first part) messageId.String  
  • No labels