This call retrieves a summary of all carrier responses received from for a particular outgoing message. The response will include all of the delivery receipts we received for this particular message from each stage of the routing process. (See type for more details).

Request

Below is an example of the URL request for this information.

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

Response

Below is an example of the response you might get to the above request. The unique elements for this response are highlighted in yellow. Description of each highlighted element and the attribute found in the response are found in the table below.

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

mtMessageResponses

The main element wrapper for all responses.

mtMessageResponse

The main element wrapper for each individual response.

Attribute Name	Description	Data Type
`messageId`	The unique identifier assigned to the message when it was submitted.	String
`submitterMessageId`	The client-defined identifier for the message if set while submitting the message.	String
`fwdToMessageId`	If the original send utilized alternate message delivery (available for v3.1+ only), this attribute may appear in your response. The value will be the unique message ID of the alternate message that was sent when the original message failed.
`fwdFromMessageId`	If your original send utilized alternate message delivery (available for v3.1+ only) and the message you requested information on was not the original message, this attribute may appear in your response. The value will be the unique message ID of the original message that was attempted and failed.
`receiptDate`	Date the response was received in standard XML format.	String

type

Delivery receipts are sent at each step of the process, and each receipt received will be summarized in the response for this request. The type element indicates which processing stage generated the delivery receipt. The possible values are as follows:

System: The receipt was generated while the message was being routed to the carrier by the Message API system.
Carrier: The receipt was generated while submitting the message to the carrier.
Handset: The receipt was generated while submitting the message to the handset.

status

This element contains the attributes that indicates if there was an error when trying to deliver the message. If isError="false", then no error was returned. If isError="true", then an error was returned, and the following attributes and sub-elements may be displayed.

Attribute	Description
`description`	This element provides a description of the error if an error is present. If no error is present, it will read `MtMessage successfully delivered to Carrier`.
`errorCode`	If the message fails, this element contains the error code that describes the specific failure reason. See HTTP Error and Status Codes for more info.
`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.

multipart

The wrapper element that has all information about a message that was split into multiple messages due to length. This element is present only if the request had splitlongmessage set to True, and the length was over 160 characters.

Attribute	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