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 18 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>
		<code> </code>
	</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 type of response. The possible values are

  • Handset: The status update was while submitting the messages to the Handset
  • Carrier: The status 
  • System:

 

no

 

 

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

 

 

 

 

 

 

 

  • No labels