Post an 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: 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 throughput and performance.
XML Request
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 |
|
| 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
| 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 (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 | |||
noOfParts | if the request had splitLongMessage set to True and the original Long message got split into multiple parts, it's the total number of parts original message got split into | String | |||
partNumber | if the request had splitLongMessage set to True and the original Long message got split into multiple parts, it's the reference part number for current part of the long message | String | |||
originalMessageUid | if the request had splitLongMessage set to True and the original Long message got split into multiple parts, it's original (first part) messageUid | String |