API Reference

Receive MMS

If you’d like to give end users to option to send MMS to your endpoint, you’ll need to configure your endpoint to receive these calls from Vibes. For more information on setting up your endpoint and whitelisting IPs, see our Receive SMS article

The format and parameters of each request and response may vary depending on the MM7 version that you choose to receive. Be sure you’ve selected your MM7 version before you begin.

👍

Blank responses

The MO and delivery 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.

Request

This example highlights one example MIME payload. Please note that any MIME-formatted data can be delivered, as the content is created by the device and passed through without modification or alteration. This should be used as one example format and individual payloads can have varied MIME data.

Vibes supports MM7 protocol for multiple versions of MM7, so be sure you’re referencing the correct MM7 version before you get started.

****
 ****
  ****
  ****
  CHOOSE YOUR MM7 VERSION BY SELECTING THE CORRESPONDING TAB ABOVE
  ****
  ****
 ****
****

POST /client/mms/deliver HTTP/1.1
Content-Type: multipart/related; type="text/xml"; boundary="----=_Part_1_2045721805.1414695261749"
User-Agent: Java/1.6.0_65
Host: 127.0.0.1:8092
Connection: keep-alive
Content-Length: 47103
POST /client/mms/deliver HTTP/1.1
Content-Type: multipart/related; type="text/xml"; boundary="----=_Part_1_2045721805.1414695261749"
User-Agent: Java/1.6.0_65
Host: 127.0.0.1:8092
Connection: keep-alive
Content-Length: 47103
------=_Part_1_1764018763.1515602889819
Content-Type: text/xml; charset=utf-8
Content-Transfer-Encoding: 8bit
Content-ID: <rootpart>
<?xml version=“1.0” encoding=“utf-16"?>

<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”>ea92fdc3-44e9-466a-9c40-f51a704a2590</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:SubmitReq xmlns=“http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-5-MM7-1-2”>
            <ns3:MM7Version>5.3.0</ns3:MM7Version>
            <ns3:SenderIdentification>
                <ns3:SenderAddress>
                    <ns3:ShortCode>12345</ns3:ShortCode>
                </ns3:SenderAddress>
            </ns3:SenderIdentification>
            <ns3:Recipients>
                <ns3:To>
                    <ns3:Number>1234567890</ns3:Number>
                </ns3:To>
            </ns3:Recipients>
            <ns3:DeliveryReport>true</ns3:DeliveryReport>
            <ns3:Subject>testing mms</ns3:Subject>
            <ns3:Content href=“cid:attachment.cid”/>
        </ns3:SubmitReq>
    </soapenv:Body>
</soapenv:Envelope>
------=_Part_1_1764018763.1515602889819
Content-Type: multipart/related; boundary=“----=_Part_1_508319571.1515623980041"; type=“image/jpeg; name=connect.jpg”; start=“<connect.jpg>”
Content-Transfer-Encoding: binary
Content-ID: <attachment.cid>
------=_Part_1_508319571.1515623980041
Content-Type: image/png; name=images
Content-Transfer-Encoding: base64
Content-Disposition: attachment; filename=images
Content-ID: <images>
iVBORw0...
------=_Part_1_508319571.1515623980041--
------=_Part_1_1764018763.1515602889819--

POST /client/mms/deliver HTTP/1.1
Content-Type: multipart/related; type="text/xml"; boundary="----=_Part_1_2045721805.1414695261749"
User-Agent: Java/1.6.0_65
Host: 127.0.0.1:8092
Connection: keep-alive
Content-Length: 47103
------=_Part_1_2045721805.1414695261749
Content-Type: text/xml; charset=utf-8
Content-Transfer-Encoding: 8bit
Content-Id: 549710183.1414695261747.sun-soap.jeetumac.local
<?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">becc3e4a6e065bd6</mm7:TransactionID>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <mm7:DeliverReq 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:MMSRelayServerID />
            <mm7:Sender>
                <mm7:Number>+13127536330</mm7:Number>
            </mm7:Sender>
            <mm7:Recipients>
                <mm7:To>
                    <mm7:ShortCode>63901</mm7:ShortCode>
                </mm7:To>
            </mm7:Recipients>
            <mm7:Priority>Normal</mm7:Priority>
            <mm7:Subject>Hello Client</mm7:Subject>
        </mm7:DeliverReq>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
------=_Part_1_2045721805.1414695261749
Content-Type: multipart/mixed;
    boundary="----=_Part_1_504396287.1414695261748"
Content-ID: <<sample.gif>-<Simple.txt>>
Content-Disposition: inline; filename="null"
------=_Part_1_504396287.1414695261748
Content-Type: image/gif; name=sample.gif
Content-Disposition: attachment; filename=sample.gif
Content-ID: <sample.gif>
GIF89aÔ ....
------=_Part_1_504396287.1414695261748
Content-Type: text/plain; name=Simple.txt
Content-Disposition: attachment; filename=Simple.txt
Content-ID: <Simple.txt>
Simple Attachment
------=_Part_1_504396287.1414695261748--
------=_Part_1_2045721805.1414695261749--

Elements & Attributes of Request

ElementVersionRequired?Description
TransactionIDBothYesThe transactionID associated with the message. Making this unique per request should help with the request tracking within the system.
MessageTypeBothYesDeliverReq
MM7VersionBothYesFOR MM7 5.5.0:
5.3.0
The MM7Version should be set to 5.3.0 because of a bug in the 5.5.0 XSD.

FOR MM7 6.8.0:
6.8.0
SenderIdentification5.5.0YesWrapper for MM7 5.5.0 that contains data around the sender of the MMS.
SenderAddress5.5.0YesThe source address of the MMS message. The short code element within the SenderAddress should have the source.
Sender6.8.0YesThe MDN that sent theMOMMS.

The MDN will be formatted in E.164 format.

The MDN will be wrapped in a <Number> element.
VASPIDBothNoNot used. Authentication is based on the Authorization header value.
VASIDBothNoNot used. Authentication is based on the Authorization header value.
LinkedID6.8.0Not used.
RecipientsBothYesThe destination address for the MMS. The Number element within Recipients → To should contain the destination.
Previouslysentby6.8.0No
Previouslysentdateandtime6.8.0No
SenderSPI6.8.0No
RecipientSPI6.8.0No
TimeStampBothNo
ReplyChargingID6.8.0No
PriorityBothNoMessage priority.
SubjectBothNoThe subject sent along with the MMS message.
ApplicID6.8.0No
ReplyApplicID6.8.0No
AuxApplicInfo6.8.0No
UACapabilities6.8.0No
ContentBothNo
hrefBothNo

Response

Below is an example of the response that should be generated by your endpoint and returned to Vibes. This sample complies with our specifications.

****
 ****
  ****
  ****
  CHOOSE YOUR MM7 VERSION BY SELECTING THE CORRESPONDING TAB ABOVE
  ****
  ****
 ****
****

<?xml version="1.0" encoding="utf-16"?>
<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">becc3e4a6e065bd6</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:DeliverRsp 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:DeliverRsp>
    </soapenv:Body>
</soapenv:Envelope>


<?xml version="1.0" encoding="utf-16"?>
<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">becc3e4a6e065bd6</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:DeliverRsp 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:DeliverRsp>
    </soapenv:Body>
</soapenv:Envelope>

Elements & Attributes of Response

ElementRequired?Description
TransactionIDYesThe transactionID associated with the message.
MM7VersionYesFOR MM7 5.5.0:
5.3.0
The MM7Version should be set to 5.3.0 because of a bug in the 5.5.0 XSD.

FOR MM7 6.8.0:
6.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.