MM7 Submit

Table of Contents

MM7_Submit
MM7_Submit.REQ
MM7_Submit.RES
MT Submit Full Example
Unsupported MM7 SOAP Elements

MM7_Submit

Send MMS MT to end users

To send a multimedia message, submit the SubmitReq MM7 SOAP to the API Endpoint with the multimedia message as the payload. When the API endpoint accepts the request, it acknowledges with a success status using a SubmitRsp MM7 SOAP. This indicates that the message was accepted for delivery. It does not, however, indicate that the message was delivered to the device. If the message was received in error, it responds with a failure status using the RSErrorRsp SOAP Fault.

MM7_Submit.REQ

Supported MM7 SOAP envelope request elements

Element	Description	Required
TransactionID	The identification of the MM7 SubmitReq/SubmitRsp pair. It is located in the SOAP header. You supply this in the MM7 SubmitReq and the system returns it in the corresponding SubmitRsp.	Yes
SubmitReq	Identifies the message as an MMS MT submit. This is the message type for an MT request.	Yes
MM7Version	Identifies the MM7 Version. See all supported MM7 Versions & Namespaces	Yes
VASPID	We provide an API key after your account is provisioned which is your VASPID.	Yes
VASID	Your account manager will provide you with a VASID for each shortcode. It is mandatory for accounts using shared shortcodes, otherwise optional.	No
SenderAddress	This is your shortcode. Should be provisioned and configured to your account and service.	Yes
Recipients	The mobile phone number of the end user. This must be a valid mobile number in international format without a leading + symbol; for example 12515550123 (US) and 447700900750 (UK). Multiple numbers are NOT supported.	Yes
Subject	Title of the whole multimedia message. Recommended size is 80 characters.	No
Content	Content of the multimedia message. href:cid attribute links to the attachment.	Yes
allowAdaptations	Indicates if you wish to allow the mobile operator to re-encode (transcode) the content to make the content more suitable to the target handset. Each mobile operator may choose to obey or ignore this field; for example, some mobile operators assume or require by default the option to transcode content. AllowAdaptations is an attribute of Content element. The value must be Boolean (either true or false).	Yes

See Unsupported elements

Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Header>
        <TransactionID xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4" soap-env:mustUnderstand="1">1000001</TransactionID>
    </soap-env:Header>
    <soap-env:Body>
        <SubmitReq xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">
            <MM7Version>6.8.0</MM7Version>
            <SenderIdentification>
                <VASPID>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</VASPID>
                <SenderAddress>
                    <ShortCode>00000</ShortCode>
                </SenderAddress>
            </SenderIdentification>
            <Recipients>
                <To>
                    <Number>10000000001</Number>
                </To>
            </Recipients>
            <Subject>My first MM7 Message</Subject>
            <Content allowAdaptations="false" href="cid:generic" />
        </SubmitReq>
    </soap-env:Body>
</soap-env:Envelope>

MM7_Submit.RES

Supported MM7 SOAP envelope response elements

Element	Description	Returned
TransactionID	The identification of the MM7 SubmitReq/SubmitRsp pair. It is located in the SOAP header. You supply this in the MM7 SubmitReq and the system returns it in the corresponding SubmitRsp.	Yes
SubmitRsp	Identifies the message as an MM7 Submit Response. This is the message type for an MT response.	Yes
MM7Version	Identifies the MM7 Version. See all supported MM7 Versions & Namespaces	Yes
StatusCode	MT message submission acceptance/rejection is based on Success/Failure status code. “Success” response does not mean the message was delivered to the handset. See all Status Codes	Yes
StatusText	Description of the status code.	Yes
MessageId	If the MT message submit is successful then this contains the system-generated ID of the submitted message. This ID is expected in the delivery reports relating to this message.	Yes

Example: Success

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Header>
        <TransactionID xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4" soap-env:mustUnderstand="1">1000001</TransactionID>
    </soap-env:Header>
    <soap-env:Body>
        <SubmitRsp xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">
            <MM7Version>6.8.0</MM7Version>
            <Status>
                <StatusCode>1000</StatusCode>
                <StatusText>Successfully parsed and validated request</StatusText>
            </Status>
            <MessageID>xxxxxx-xxxxx-xxx</MessageID>
        </SubmitRsp>
    </soap-env:Body>
</soap-env:Envelope>

Example: Failure

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Header>
        <TransactionID xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4" soap-env:mustUnderstand="1">1000001</TransactionID>
    </soap-env:Header>
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Client</faultcode>
            <faultstring>Client error</faultstring>
            <detail>
                <RSErrorRsp xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">
                    <MM7Version>6.8.0</MM7Version>
                    <Status>
                        <StatusCode>2007</StatusCode>
                        <StatusText>Unable to parse request</StatusText>
                        <Details>Message format corrupt</Details>
                    </Status>
                </RSErrorRsp>
            </detail>
        <soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

MT Submit Full Example

Request:

POST /mm7/v1 HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Host: {Host Base URL}
Accept: */*
Content-Type: multipart/related; boundary="mainBoundary"; type="text/xml"; start="<mm7-start>"
SOAPAction: "http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4"
Content-Length: 45454
Expect: 100-continue

--mainBoundary
Content-Type: text/xml; charset=utf-8
Content-ID: <mm7-start>

<?xml version="1.0" encoding="utf-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Header>
        <TransactionID xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4" soap-env:mustUnderstand="1">1000001</TransactionID>
    </soap-env:Header>
    <soap-env:Body>
        <SubmitReq xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">
            <MM7Version>6.8.0</MM7Version>
            <DeliveryReport>true</DeliveryReport>
            <SenderIdentification>
                <VASPID>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</VASPID>
                <SenderAddress>
                    <ShortCode>00000</ShortCode>
                </SenderAddress>
            </SenderIdentification>
            <Recipients>
                <To>
                    <Number>10000000001</Number>
                </To>
            </Recipients>
            <Subject>My first MM7 Message</Subject>
            <ExpiryDate>2015-05-24T18:54:48+00:00</ExpiryDate>
            <TimeStamp>2015-05-21T18:54:48+00:00</TimeStamp>
            <Content allowAdaptations="false" href="cid:generic_content_id"/>
        </SubmitReq>
    </soap-env:Body>
</soap-env:Envelope>

--mainBoundary
Content-Type: multipart/related; start="<mms.smil>";
    boundary="subBoundary"; type="text/xml"
Content-ID: <generic_content_id>

--subBoundary
Content-Type: text/plain; charset=utf-8
Content-ID: <132c4ca56a209475>

MM7 Test Text
--subBoundary
Content-Type: application/smil; charset=utf-8
Content-ID: <mms.smil>

<?xml version="1.0" encoding="UTF-8"?><smil><head><layout><root-layout width="100%" height="100%"/><region id="Text" top="50%" left="0" height="50%" width="100%" fit="hidden"/></layout></head><body><par><text src="cid:132c4ca56a209475" region="Text"/></par></body></smil>
--subBoundary--

--mainBoundary--

Response:

HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8
Date: Mon, 16 Mar 2015 17:46:59 GMT
Server: Apache
Vary: Accept-Encoding,User-Agent
Content-Length: 715
Connection: keep-alive

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Header>
        <TransactionID xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4" soap-env:mustUnderstand="1">1000001</TransactionID>
    </soap-env:Header>
    <soap-env:Body>
        <SubmitRsp xmlns="http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">
            <MM7Version>6.8.0</MM7Version>
            <Status>
                <StatusCode>1000</StatusCode>
                <StatusText>Successfully parsed and validated request</StatusText>
            </Status>
            <MessageID>xxxxxx-xxxxx-xxx</MessageID>
        </SubmitRsp>
    </soap-env:Body>
</soap-env:Envelope>

Unsupported MM7 SOAP Elements

MM7_Submit.REQ

Element	Behavior	Description
ApplicID	Stripped	This information element contains the identification of the destination application. Upon reception, the recipient MMS VAS Application shall provide this MM7_retrieve.REQ to the specified destination application
AuxApplicInfo	Stripped	If present, this information element indicates additional application/implementation-specific control information
ChargedParty	Stripped	An indication of which party is expected to be charged for a Message submitted by the VASP, e.g. the sender, receiver, both parties, or neither. Possible values are “Sender”, “Recipient”, “Both”, “Neither”
ChargedPartyID	Stripped	The address/id of the third party which is expected to pay for the Message.
ContentClass	Stripped	Classifies the content of the MM to the smallest content class to which the MM belongs. Possible values are “text”, “image-basic”, “image-rich”, “video-basic”, “video-rich”, “megapixel”, “content-basic”, “content-rich”
DeliveryCondition	Stripped	If the condition is met the MM shall be delivered to the recipient MMS User-Agent, otherwise the MM shall be discarded. The initial values are MMS capable only; HPLMN only; any other values can be added based on bilateral agreements between the MMS Relay/Server operator and the VASP.
DeliveryReport	Default to true	A request for delivery report. The boolean value true/false. Ask your account manager to turn off delivery reports.
DistributionIndicator	Stripped	If set to ‘false’ the VASP has indicated that the content of the MM is not intended for redistribution. If set to ‘true’ the VASP has indicated that the content of the MM can be redistributed. Boolean value true/false
DRMContent	Stripped	Indicates if the MM contains DRM-protected content. Boolean value true/false
EarliestDeliveryTime	Stripped	The earliest desired time of delivery of the MM to the recipient (timestamp). Date format is absolute or relative
ExpiryDate	Default to 3 days	The desired time of expiry for the MM (timestamp). The date format is absolute. If the Expiry date is not provided or if it is greater than 3 days, then the 3 day default is applied. If an ExpiryDate less than 3 days is used this date is passed through. Mobile Network operators have their own limits and logic and may overwrite the ExpiryDate again. Example Date Format: 2020-08-31T14:23:00+00:00
LinkedID	Stripped	This identifies correspondence to a previous valid message delivered to the VASP.
MessageClass	Pass Through	Class of the MM (e.g. “Informational”, “Advertisement”, “Auto”)
Priority	Pass Through	The priority (importance) of the message. Possible values are “High”, “Normal”, “Low”
ReadReply	Stripped	A request for confirmation via a read report to be delivered. Boolean true/false value. Set it ‘true’ to receive MM7 Read Replies.
ReplyApplicID	Stripped	If present, this information element indicates a “reply path”. It contains the application identifier which shall be used by the recipient MMS VAS Application when a reply-MM or a read-reply report is created
ReplyCharging	Stripped	A request for reply-charging. No value. Presence implies true
replyChargingSize	Stripped	In case of reply-charging the maximum size for reply-MM(s) granted to the recipient(s). Optional attribute of ReplyCharging element. Positive integer value
replyDeadline	Stripped	In case of reply-charging the latest time of submission of replies granted to the recipient(s) (timestamp). The optional attribute of the ReplyCharging element. Date format is absolute or relative
ServiceCode	Pass Through	Information supplied by the VASP which may be included in charging/billing information. The syntax and semantics of the content of this information are out of the scope of this specification.
TimeStamp	Default to Submit time	The time and date of the submission of the MM (timestamp). This is overwritten with the current timestamp value always. If not passed, then it gets added at the API endpoint before it gets submitted to the Carrier gateway.

Updated on September 22, 2021

Messaging Platform KB

Mobile Wallet Platform KB

Content Tools

Mobile Wallet API

MMS MM7 API

Messaging API v1

Messaging API v2

Content API V2

MM7 Submit

MM7_Submit

Send MMS MT to end users

MM7_Submit.REQ

Supported MM7 SOAP envelope request elements

Example

MM7_Submit.RES

Supported MM7 SOAP envelope response elements

Example: Success

Example: Failure

MT Submit Full Example

Request:

Response:

Unsupported MM7 SOAP Elements

MM7_Submit.REQ