Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Last Updated:

Lastupdatedate

Livesearch
placeholderSearch the Vibes Developer Wiki
typepage



Post a Mobile Terminated (MT) message response to the client URL (if configured).

This callback is a Vibes-initiated request to the client to attempt delivery of carrier responses. The delivery of these messages is contingent on the client configuring the receiptOption tag on the original submission of the MT message.

Note
Note: The client endpoint should properly store/record the response and then return an HttpResponse; 200 to acknowledge receipt. The client process should keep actual processing/logic as small as possible for good throughput and performance.


Note
titleNote: The submitMtMessageResponse callback does NOT support Basic Auth.


XML Request Example

Code Block
POST

<?xml version="1.0" encoding="UTF-8"?>
<mtMessageResponse messageId="865cd3d1-bea6-4a6f-8bac-bae483248a27" 
	submitterMessageId="239487234987234" 
	receiptDate="2011-04-19T15:10:08.320-05:00"> 
	<multipart isMultipart="true" originalMessageId="865cd3d1-bea6-4a6f-8bac-bae483248a27" noOfParts="2" partNumber="1" />  
	<type>System|Carrier|Handset</type>
	<status isError="true|false">
		<description>Description of status</description>
		<errorCode>100</errorCode>
		<internalErrorCode>255</internalErrorCode>
	</status>
</mtMessageResponse>

Attribute Descriptions

Element

Attribute

Description

Data Type

Required

Default

mtMessageResponse

 

Main wrapper element indicating that this is a MtMessage Response.

 

Yes

 

 

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 on callbacks for the original message, and the value will be the identifier of the message forwarded on the alternate source address.StringNo 
 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 Application Program Interface (API).StringNo 

 

receiptDate

Date the response was received in standard XML format.

String

Yes

 

type

 

The processing stage at which the response was generated. The possible value 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

 

The error code if the status is an error status.

Numeric

No

 

internalErrorCode

 

The internal error code if the status is an error status.

Numeric

No

 

multipart
 

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

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