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 17 Next »

Requests and Responses

The format and parameters of each request and response may vary depending on the MM7 version that you choose to receive. 

Select your MM7 version below to see the version-specific parameters and sample requests. 

 

Request Parameters

ElementRequiredDescription

TransactionID

YesThe transactionID associated with the message. Making this unique per request should help with the request tracking within the system.
MM7VersionYes

5.3.0
The MM7Version should be set to 5.3.0 because of a bug in the 5.5.0 xsd.

MessageIDYesThe MessageId returned in the SubmitReq type.
RecipientYesThe recipient address for the MMS. The Number element within Recipients
SenderYes

The source address for the MMS. The Shortcode element within Sender

DateYesThe date and time the report was generated. Format is the XML datetime format: yyyy-MM-dd'T'HH:mm:ssZ
MMStatusYes

The delivery status of the message. Possible Values

  • Retrieved
  • Expired
  • Forwarded
  • Indeterminate
  • Rejected

StatusText

NoDescription of the status

Response Parameters

Element
Required
Description

TransactionID

YesThe transactionID associated with the message from the submit request.
MM7Versionfalse

5.3.0

The MM7Version should be set to 5.3.0 because of a bug in the 5.5.0 xsd.

StatusCodeYesA numeric code indicating the result of the request.
StatusTextYesA free-text description of the result of the request
DetailsNoOptional free-text that may be included to further describe the result of the request


Sample Request

<?xml version="1.0" encoding="utf-16"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header>
        <mm7:TransactionID SOAP-ENV:mustUnderstand="1" xmlns:mm7="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-5-MM7-1-2">bddf328cc0e36a25</mm7:TransactionID>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <mm7:DeliveryReportReq xmlns:mm7="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-5-MM7-1-2">
            <mm7:MM7Version>5.3.0</mm7:MM7Version>
            <mm7:MessageID>b26bc7214535794d71f36ee31496284e900-7ffa</mm7:MessageID>
            <mm7:Recipient>
                <mm7:Number>+13127536330</mm7:Number>
            </mm7:Recipient>
            <mm7:Sender>
                <mm7:Shortcode>63901</mm7:Shortcode>
            </mm7:Sender>
            <mm7:Date>2014-10-30T21:07:54Z</mm7:Date>
            <mm7:MMStatus>Retrieved</mm7:MMStatus>
        </mm7:DeliveryReportReq>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Sample Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
    <TransactionID xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-5-MM7-1-2">fa74d713-e27a-425c-aeec</TransactionID>
</soapenv:Header>
<soapenv:Body xmlns:ns3="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-5-MM7-1-2">
<ns3:DeliveryReportRsp xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-5-MM7-1-2">
<ns3:Status>
    <ns3:StatusCode>1000</ns3:StatusCode>
    <ns3:StatusText>Success</ns3:StatusText>
</ns3:Status>
</ns3:DeliveryReportRsp>
</soapenv:Body>
</soapenv:Envelope>



Request Parameters

ElementRequiredDescription

TransactionID

YesThe transactionID associated with the message. Making this unique per request should help with the request tracking within the system.
MM7VersionYes6.8.0
MessageIDYesThe MessageId returned in the SubmitReq type.
RecipientYesThe recipient address for the MMS. The Number element within Recipients
SenderYesThe source address for the MMS. The Shortcode element within Sender
DateYesThe date and time the report was generated. Format is the XML datetime format: yyyy-MM-dd'T'HH:mm:ssZ
MMStatusYes

The delivery status of the message. Possible Values

  • Retrieved
  • Deferred
  • DeliveryConditionNotMet
  • Expired
  • Forwarded
  • Indeterminate
  • Rejected
  • Unrecognised

MmStatusExtension

NoNot Supported
StatusTextNoDescription of the status

ApplicID

NoNot Supported

ReplyApplicID

NoNot Supported

AuxApplicInfo

NoNot Supported

UAProf

NoIf supported by the Carrier, it is set within the UACapabilities element.

timeStamp

NoIf supported by the Carrier, it is set within the UACapabilities element. This has the last known update of the UACapabilities

Response Parameters

Element
Required
Description

TransactionID

YesThe transactionID associated with the message from the submit request.
MM7Versionfalse6.8.0
StatusCodeYesA numeric code indicating the result of the request.
StatusTextYesA free-text description of the result of the request
DetailsNoOptional free-text that may be included to further describe the result of the request.


Sample Request

<?xml version="1.0" encoding="utf-16"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header>
        <mm7:TransactionID SOAP-ENV:mustUnderstand="1" xmlns:mm7="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">bddf328cc0e36a25</mm7:TransactionID>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <mm7:DeliveryReportReq xmlns:mm7="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">
            <mm7:MM7Version>6.8.0</mm7:MM7Version>
            <mm7:MessageID>b26bc7214535794d71f36ee31496284e900-7ffa</mm7:MessageID>
            <mm7:Recipient>
                <mm7:Number>+13127536330</mm7:Number>
            </mm7:Recipient>
            <mm7:Sender>
                <mm7:Shortcode>63901</mm7:Shortcode>
            </mm7:Sender>
            <mm7:Date>2014-10-30T21:07:54Z</mm7:Date>
            <mm7:MMStatus>Retrieved</mm7:MMStatus>
        </mm7:DeliveryReportReq>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Sample Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
    <TransactionID xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">fa74d713-e27a-425c-aeec</TransactionID>
</soapenv:Header>
<soapenv:Body xmlns:ns3="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">
<ns3:DeliveryReportRsp xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">
<ns3:Status>
    <ns3:StatusCode>1000</ns3:StatusCode>
    <ns3:StatusText>Success</ns3:StatusText>
</ns3:Status>
</ns3:DeliveryReportRsp>
</soapenv:Body>
</soapenv:Envelope> 
  • No labels