Versions Compared

Key

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

...

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"> 
	<type>System|Carrier|Handset</type>
	<status isError="true|false">
		<description>Description of status</description>
		<code>100<<errorCode>100</code>errorCode>
	</status>
</mtMessageResponse>

...

Element

Attribute

Description

Data Type

Required

Default

mtMessageResponse

 

Main wrapper element indicating that this is a MtMessage Response

 

yes Yes

 

 

messageId

The unique identifier assigned to the message when it was submitted

String

yes Yes

 

 

submitterMessageId

The client definable identifier for the message when it was submitted

String

yes Yes

 

 

receiptDate

Date the response was received in standard XML format

String

yes Yes

 

 

 

 

 

 

 

type

 

The type of responseprocessing stage at which the response was generated. The possible values value are

  • Handset: The status update was while submitting the messages System: While the message was being routed to the Carrier by the Message API system
  • Carrier: While submitting the message to the Carrier
  • Handset: While submitting the message to the Handset.
  • Carrier: The status 
  • System:

String

Yes

 

no status

 

Element that has the status of the message

 

type

The type of response. The value of this attribute will be selected from the following possible values: Handset, Carrier.
Handset = SMPP Delivery Receipts
Carrier = SMPP MT responses
TODO need an option for messages that fail before carrier send (e.g. gateway not found)

String

yes

 

 

timestamp

The date/time the response was received from the carrier

Datetime

yes

 

 

 

 

 

  Yes

 

 

isError

Identifies whether the status is an error status.

Boolean

Yes

 

description

 

Description of the status.

String

Yes

 

errorCode

 

The error code associated with the status of the Message if it failed.

 

No