Page History
...
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 |
|
| forwardedMessageId | If 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. | String | No | ||
| originalMessageId | If 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. | 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 |
Overview
Content Tools