Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Last Updated:

Lastupdatedate

Livesearch
placeholderSearch the Vibes Developer Wiki
typepage



Authorization Header

All Submit requests should utilize Basic Auth to specify user credentials for authentication and authorization. This header must be present for all Application Program Interface (API) requests, or else an authentication error will be returned. Refer to the section on Authentication for information.

During your account setup, you should receive the following:

  • A username for the Basic Auth.
  • A link to create a password for the Basic Auth.

Custom Headers

HeaderDescription
X-Vibes-CarrierCodeThe Vibes Carrier Code, if known, otherwise the carrier is looked up.
X-Vibes-DlrCallbackUrl

The URL to which Delivery Reports should be sent.

Delivery Report request options

The table below specifies how the Multimedia Message Service Center (MMSC) would process the various Delivery Report request options.

 X-Vibes-DlrCallbackUrl Header SetX-Vibes-DlrCallbackUrl Header Not Set
Delivery Report Flag Set to TruetrueDelivery Reports will be requested from the carrier, and any final status report returned from the carrier is sent to the Callback URL.Delivery Reports are requested from the carrier but no callbacks are sent to the client.
Delivery Report Flag Set to FalsefalseThe status of delivery of the message to carrier is returned to the Callback URL. Delivery Reports are not requested from the carrier.Delivery reports are not requested from the carrier and no callbacks are sent to the client.

Requests and Responses

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

Note
Note: Some parameters are not supported by all carriers. 

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

Localtab Group


Localtab
activetrue
titleMM7 5.5.0

Request Parameters

ElementRequiredDescription

TransactionID

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

5.3.0

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

VASPID

NoNot used. Authentication is based on the Authorization header value.
VASIDNoNot used. Authentication is based on the Authorization header value.

SenderAddress

YesThe shortcode that is sending the Mobile Terminated (MT) Multimedia Message Service (MMS). This value is required by the Vibes MMSC (even though the specification says it is optional).
RecipientsYes

The Mobile Directory Number (MDN) to deliver the MMS to.
The MDN can be formatted as 10 digit, 11 digit, or e.164 format.
The MDN should be wrapped in a <Number> element.
The Number element should be wrapped in a <To> element.
Multiple MDNs are not supported.
The <Cc> and <Bcc> elements are not supported. 
The displayOnly flag will not be used because the Vibes MMSC only allows one recipient per message. 

ServiceCodeNoNot supported, do not set.
LinkedIDNo

Not supported, do not set.

MessageClassNo

The type of message. The allowed values are:

  • Personal
  • Informational
  • Advertisement
  • Auto

Informational is the default.

TimestampNoNot supported, do not set.
ReplyChargingNoNot supported, do not set.
EarliestDeliveryTimeNoNot supported, do not set.
ExpiryDateNoNot supported, do not set.

DeliveryReport

No

Flag to request delivery reports for this MT MMS message.

If True true, at least one DeliveryReportReq request will be posted to the client-specified URL sometime after the request has been received. It defaults to False false.

If this flag is set to Truetrue, then the X-Vibes-DlrCallbackUrl custom header should have the URL to which Delivery Reports should be sent, or else the request will be rejected.

ReadReply

NoFlag to request read replies. If True true, at least one ReadReplyReq request will be posted to the client-specified URL sometime after the request has been received. Defaults to False false.

Priority

NoThe importance of the message: Normal, High, or Low.

Subject

NoFree-text to be displayed as the title of the message on the handset.
ChargedPartyNoNot supported, do not set.

DistributionProtection

NoThe flag on whether to allow message forwarding from the phone. Defaults to False false.
ContentNoThis value is required by the Vibes MMSC (even though the spec says its optional).
hrefNo

A String reference to the content contained within the message.
Formatted: "cid:<filename>"

allowAdaptationsNoAllow the content to be adapted for the phone by the carrier MMSC. This is set to False false by default.

Response Parameters

ElementRequiredDescription

TransactionID

YesThe transactionID associated with the message from the submit request.
MessageIDYesIf the request was successful, this element will contain the unique identifier generated by the Vibes MMSC for the message. This ID should be stored for future reference.
MM7VersionYes

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.


Code Block
POST /mms/mm7/submit HTTP/1.1
SOAPAction: 
Authorization: Basic Y2xpZW50QHZpYmVzLmNvbTpwYXNzd29yZA==
User-Agent: Jakarta Commons-HttpClient/3.1
Host: 127.0.0.1:8081
Content-Length: 47384
Content-Type: multipart/related; type="text/xml"; boundary=MIMEBoundary_22efcfd39d40f1e286128d53c1fe240ba31d19c88ba31f5c; start="<32efcfd39d40f1e286128d53c1fe240ba31d19c88ba31f5c@apache.org>" 
X-Vibes-CarrierCode: 102
 
--MIMEBoundary_22efcfd39d40f1e286128d53c1fe240ba31d19c88ba31f5c
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: binary
Content-ID: <32efcfd39d40f1e286128d53c1fe240ba31d19c88ba31f5c@apache.org>

<?xml version="1.0" encoding="utf-8"?>
<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>63901</ns3:ShortCode>
                </ns3:SenderAddress>
            </ns3:SenderIdentification>
            <ns3:Recipients>
                <ns3:To>
                    <ns3:Number>+13127536330</ns3:Number>
                </ns3:To>
            </ns3:Recipients>
            <ns3:DeliveryReport>true</ns3:DeliveryReport>
            <ns3:Subject>Hello Vibes</ns3:Subject>
            <ns3:Content href="cid:attachment.cid"/>
        </ns3:SubmitReq>
    </soapenv:Body>
</soapenv:Envelope>
--MIMEBoundary_22efcfd39d40f1e286128d53c1fe240ba31d19c88ba31f5c
Content-Type: multipart/mixed; 	boundary="----=_Part_1_735700397.1414682699327"
Content-Transfer-Encoding: binary
Content-ID: <attachment.cid>
 
------=_Part_1_735700397.1414682699327
Content-Type: image/gif; name=sample.gif
Content-Disposition: attachment; filename=sample.gif
Content-ID: <sample.gif>
 
GIF89aÔÔ ...
------=_Part_1_735700397.1414682699327
Content-Type: text/plain; name=Simple.txt
Content-Disposition: attachment; filename=Simple.txt
Content-ID: <Simple.txt>
 
Simple text as an attachment ...
------=_Part_1_735700397.1414682699327--
 
--MIMEBoundary_22efcfd39d40f1e286128d53c1fe240ba31d19c88ba31f5c--

 



Localtab
titleMM7 6.8.0

Request Parameters

ElementRequiredDescription

TransactionID

Yes

The transactionID associated with the message. Making this unique per request should help with the request tracking within the system.
\@mustUnderstand should be set to 1.
\@actor and \@encodingStyle should not be set.

MM7VersionNo6.8.0

VASPID

NoNot used. Authentication is based on the Authorization header value.
VASIDNoNot used. Authentication is based on the Authorization header value.

SenderAddress

YesThe shortcode that is sending the MT MMS message. This value is required by the Vibes MMSC (even though the specification says it is optional).
The shortcode should be wrapped in a <ShortCode> element.
RecipientsYes

The MDN to deliver the MMS to.
The MDN can be formatted as 10 digit, 11 digit, or e.164 format.
The MDN should be wrapped in a <Number> element.
The Number element should be wrapped in a <To> element.
Multiple MDNs are not supported.
The <Cc> and <Bcc> elements are not supported. 
The displayOnly flag will not be used because the Vibes MMSC only allows one recipient per message. 

ServiceCodeNoNot supported, do not set.
LinkedIDNo

Not supported, do not set.

MessageClassNo

The type of message. The allowed values are:

  • Personal
  • Informational
  • Advertisement
  • Auto

Informational is the default.

TimestampNoNot supported, do not set.
ReplyChargingNoNot supported, do not set.
EarliestDeliveryTimeNoNot supported, do not set.
ExpiryDateNoNot supported, do not set.

DeliveryReport

No

Flag to request delivery reports for this MT MMS message.

If True true, at least one DeliveryReportReq request will be posted to the client-specified URL sometime after the request has been received. It defaults to False false.  

If this flag is set to True true, then the X-Vibes-DlrCallbackUrl custom header should have the URL to which Delivery Reports should be sent, or else the request will be rejected.

ReadReply

NoFlag to request read replies. If True true, at least one ReadReplyReq request will be posted to the client-specified URL sometime after the request has been received. It defaults to False false.

Priority

NoThe importance of the message: Normal, High, or Low.

Subject

NoFree-text to be displayed as the title of the message on the handset.
ChargedPartyNoNot supported, do not set.
ChargedPartyIDNoNot supported, do not set.

DistributionIndicator

NoThe flag on whether to allow message forwarding from the phone. Defaults to False false.
DeliveryConditionNoNot supported, do not set.
ApplicIDNoIdentification information for the destination application on the handset. If set, this information will be passed through to the carrier.
ReplyApplicIDNoIdentification information for the application which will handle delivery reports, read-reply reports and reply-MMS. If set, this information will be passed through to the carrier.
AuxApplicInfoNoAdditional application/implementation specific control information. If set, this information will be passed through to the carrier.
ContentClassNo

Classification information for the message content. If set, this information will be passed through to the carrier.
The possible values are: text, image-basic,
image-rich, video-basic, video-rich, megapixel, content-basic, content-rich.

DRMContentNoThe Boolean flag indicating if the content of the message is DRM protected.
ContentNoThis value is required by the Vibes MMSC (even though the spec says its optional).
hrefNo

A String reference to the content contained within the message.
Formatted: "cid:<filename>"

allowAdaptationsNoAllow the content to be adapted for the phone by the carrier MMSC. This is set to True true by default.

Response Parameters

ElementRequiredDescription

TransactionID

YesThe transactionID associated with the message from the submit request.
MessageIDYesIf the request was successful, this element will contain the unique identifier generated by the Vibes MMSC for the message. This ID should be stored for future reference.
MM7VersionYes6.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.


Code Block
POST /mms/mm7/submit HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: multipart/related; type="text/xml"; start="<rootpart@soapui.org>"; boundary="----=_Part_0_2057207868.1410898245437"
SOAPAction: ""
MIME-Version: 1.0
Content-Length: 10104
Host: 127.0.0.1:8081
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
X-Vibes-CarrierCode: 102
------=_Part_0_2057207868.1410898245437
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID: <rootpart@soapui.org>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rel="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">
   <soapenv:Header>
      <rel:TransactionID soapenv:mustUnderstand="true">43856aa8-3133-43e5-802d-9528a61985c8</rel:TransactionID>
   </soapenv:Header>
   <soapenv:Body>
      <rel:SubmitReq>
         <rel:MM7Version>6.8.0</rel:MM7Version>
         <rel:SenderIdentification>
               <rel:VASPID>client@example.com</rel:VASPID>
            <rel:VASID>clientpassword</rel:VASID>
            <rel:SenderAddress>
               <rel:ShortCode>63901</rel:ShortCode>
            </rel:SenderAddress>
         </rel:SenderIdentification>
         <rel:Recipients>
            <rel:To>
               <rel:Number>+13127536330</rel:Number>
            </rel:To>
         </rel:Recipients>
         <rel:Subject>"MMS Messages"</rel:Subject>
         <rel:Content href="cid:w.jpg"></rel:Content>
      </rel:SubmitReq>
   </soapenv:Body>
</soapenv:Envelope>
------=_Part_0_2057207868.1410898245437
Content-Type: multipart/mixed;
   boundary="----=_Part_1_2139855572.1410898245528"; name=w.jpg
Content-Transfer-Encoding: binary
Content-ID: <w.jpg>
Content-Disposition: attachment; name="w.jpg"; filename="w.jpg"
------=_Part_1_2139855572.1410898245528
Content-ID: <w.jpg>
Content-Disposition: attachment; name="w.jpg"; filename="w.jpg"
ˇÿˇ‡ .....
------=_Part_1_2139855572.1410898245528
Content-ID: <go.jpg>
Content-Disposition: attachment; name="go.jpg"; filename="go.jpg"
ˇÿˇ‡ .....
------=_Part_1_2139855572.1410898245528--
------=_Part_0_2057207868.1410898245437--