Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 21 Next »

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. 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"> 
	<type>System|Carrier|Handset</type>
	<status isError="true|false">
		<description>Description of status</description>
		<errorCode>100</errorCode>
	</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 message when it was submitted

String

Yes

 

 

submitterMessageId

The client definable identifier for the message when it was submitted

String

Yes

 

 

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

  • 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.

String

Yes

 

status

 

Element that has the status of the message

 

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

 

  • No labels