If you requested a delivery receipt upon submitting your MMS, Vibes will send your endpoint DeliveryReportReq when the delivery receipt information is available.
Blank responses
The MO and delivery receipt responses can support blank responses. For a client who is new to MM7 and SOAP format, this allows an easier integration by accepting a response with HTTP 200 and a response text of blank.
MM7 5.5.0
Double-check your version
Vibes supports MM7 protocol for multiple versions of MM7, so be sure you’re referencing the correct MM7 version before you get started.
Request
The elements of a request are as follows:
| Element | Required? | Description |
|---|---|---|
TransactionID | Yes | The transactionID associated with the message. |
MM7Version | Yes | 5.3.0 The MM7Version should be set to 5.3.0 because of a bug in the 5.5.0 XSD. |
MessageID | Yes | The MessageId returned in the SubmitReq type. |
Recipient | Yes | The recipient address for the MMS. The Number element within Recipients. |
Sender | Yes | The source address for the MMS. The Shortcode element within Sender. |
Date | Yes | The date and time the report was generated. Format is the XML datetime format: yyyy-MM-dd'T'HH:mm:ssZ. |
MMStatus | Yes | When requesting a delivery receipt for MMS, you will receive a response with one of five MM7 MMStatuses: - Retrieved: Success.- Rejected: Message was rejected by the carrier.- Indeterminate: Status of the message cannot be determined.- Expired: Attempt to deliver has expired.- Forwarded: Message was forwarded to another carrier or application.Note: Delays between a message being delivered to the carrier and being delivered to the handset may occur. Learn more here. |
StatusText | No | If message delivery was not successful, you may also receive <statusText>with an error code and code description. This will be populated only if there is additional information on the failure. The format is as follows:<statusText>Error {Error Code} - {Error Code Description} [ref: ##]See our delivery receipt responses appendix for a list of possible error codes. |
Examples
Status: Retrieved
<?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>
Status: Rejected
<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" soapenv:mustUnderstand="1">80e7e98c-b665-49d0-98b5-747392493acaD-1
</TransactionID>
</soapenv:Header>
<soapenv:Body
xmlns:ns2="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">
<ns2:DeliveryReportReq
xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">
<ns2:MM7Version>6.8.0</ns2:MM7Version>
<ns2:MessageID>12345a-b665-49d0-98b5-747392493aca</ns2:MessageID>
<ns2:Recipient>
<ns2:Number>+15125551212</ns2:Number>
</ns2:Recipient>
<ns2:Sender>
<ns2:ShortCode>12345</ns2:ShortCode>
</ns2:Sender>
<ns2:Date>2023-07-11T15:29:00.000-05:00</ns2:Date>
<ns2:MMStatus>Rejected</ns2:MMStatus>
<ns2:statusText>Error #301 - Invalid Content Type - The message or content type is not a supported type or maximum size exceeded. [ref: 2004]</ns2:statusText>
</ns2:DeliveryReportReq>
</soapenv:Body>
</soapenv:Envelope>
See our response codes appendix for more information. If you still need assistance with a unsuccessful delivery receipt from our Customer Care team, be sure to include the <statusText> in your message.
Response
Your system's response should include the following elements and attributes.
| Element | Required? | Description |
|---|---|---|
TransactionID | Yes | The transactionID associated with the message from the submit request. |
MM7Version | No | 5.3.0 The MM7Version should be set to 5.3.0 because of a bug in the 5.5.0 XSD. |
StatusCode | Yes | A numeric code indicating the result of the request. View status codes here. |
StatusText | Yes | A free-text description of the result of the request. |
Details | No | Optional free text that may be included to further describe the result of the request. |
Example
<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>
MM7 6.8.0
Double-check your version
Vibes supports MM7 protocol for multiple versions of MM7, so be sure you’re referencing the correct MM7 version before you get started.
Request
The elements of a request are as follows:
| Element | Required? | Description |
|---|---|---|
TransactionID | Yes | The transactionID associated with the message. |
MM7Version | Yes | 6.8.0 |
MessageID | Yes | The MessageId returned in the SubmitReq type. |
Recipient | Yes | The recipient address for the MMS. The Number element within Recipients. |
Sender | Yes | The source address for the MMS. The Shortcode element within Sender. |
Date | Yes | The date and time the report was generated. Format is the XML datetime format: yyyy-MM-dd'T'HH:mm:ssZ. |
MMStatus | When requesting a delivery receipt for MMS, you will receive a response with one of five MM7 MMStatuses: - Retrieved: Success.- Rejected: Message was rejected by the carrier.- Indeterminate: Status of the message cannot be determined.- Expired: Attempt to deliver has expired.- Forwarded: Message was forwarded to another carrier or application.Note: Delays between a message being delivered to the carrier and being delivered to the handset may occur. Learn more here. | |
MmStatusExtension | No | Not Supported. |
StatusText | No | If message delivery was not successful, you may also receive <statusText>with an error code and code description. This will be populated only if there is additional information on the failure. The format is as follows:<statusText>Error {Error Code} - {Error Code Description} [ref: ##]See our delivery receipt responses appendix for a list of possible error codes. |
ApplicID | No | Not Supported. |
ReplyApplicID | No | Not Supported. |
AuxApplicInfo | No | Not Supported. |
UAProf | No | If supported by the carrier, it is set within the UACapabilities element. |
timeStamp | No | If supported by the carrier, it is set within the UACapabilities element. This has the last known update of the UACapabilities. |
Examples
Status: Retrieved
<?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>
Status: Rejected
<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" soapenv:mustUnderstand="1">80e7e98c-b665-49d0-98b5-747392493acaD-1
</TransactionID>
</soapenv:Header>
<soapenv:Body
xmlns:ns2="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">
<ns2:DeliveryReportReq
xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">
<ns2:MM7Version>6.8.0</ns2:MM7Version>
<ns2:MessageID>12345a-b665-49d0-98b5-747392493aca</ns2:MessageID>
<ns2:Recipient>
<ns2:Number>+15125551212</ns2:Number>
</ns2:Recipient>
<ns2:Sender>
<ns2:ShortCode>12345</ns2:ShortCode>
</ns2:Sender>
<ns2:Date>2023-07-11T15:29:00.000-05:00</ns2:Date>
<ns2:MMStatus>Rejected</ns2:MMStatus>
<ns2:statusText>Error #301 - Invalid Content Type - The message or content type is not a supported type or maximum size exceeded. [ref: 2004]</ns2:statusText>
</ns2:DeliveryReportReq>
</soapenv:Body>
</soapenv:Envelope>
See our response codes appendix for more information. If you still need assistance with a unsuccessful delivery receipt from our Customer Care team, be sure to include the <statusText> in your message.
Response
Your system's response should include the following elements and attributes.
| Elements | Required? | Description |
|---|---|---|
TransactionID | Yes | The transactionID associated with the message from the submit request. |
MM7Version | No | 6.8.0 |
StatusCode | Yes | A numeric code indicating the result of the request. View status codes here. |
StatusText | Yes | A free-text description of the result of the request. |
Details | No | Optional free text that may be included to further describe the result of the request. |
Example
<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>