Recieve MMS MO submitted by end users to your platform. The message from an end user is delivered by supplying the MMS as payload of the request message. Read more.
Receive MMS MO submitted by end users to your platform
Sinch delivers messages from end users to your platform by supplying the MMS as the payload of the request message. The deliver request is made using MM7 SOAP DeliverReq. Message include identification of the request that's used by your platform to correlate a response to the message. Your platform must reply with a SOAP response DeliverRsp, indicating that the message was successfully received and will be processed. If you can't identify the requested content or if the delivered content doesn't fulfill the conditions you'd expect, then your platform should indicate a failure in the "DeliverRsp" status field.
Group Messaging, also referred to as Group Chat, is enabled by utilizing the displayonly attribute within the number node. When receiving multimedia messages, the person who initiates the message does not have the displayOnly attribute associated with their number. However, other participants in the group chat are assigned the displayOnly attribute set to true in their respective number nodes, which indicates that they are passive participants in the group chat.
This feature is only available for Sinch 10DLC MMS offering for US Wireless carriers: AT&T, T-Mobile US, Verizon Wireless, U.S. Cellular, and Google Voice.
MM7 MO deliver request elements
1. HTTP header elements
| Header Name | Description | Mandatory |
|---|---|---|
| x-mblox-operator-id | Sinch Mobile Operator ID. Examples: AT&T=0001470, Verizon=0001890. See all Sinch operator IDs. | No |
2. Elements in the SOAP header and body
| Element | Description* | |
|---|---|---|
| TransactionID | It's a Sinch generated transaction ID. Identifies the DeliverReq/DeliverRsp pair. | Always |
| DeliverReq | Identifies the message as an MM7 deliver request. | Always |
| MM7Version | Identifies the MM7 Version. (Supported versions are ver-5.3.0 and ver-6.8.0) | Always |
| Sender | 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). | Always |
| Recipients | The address of the message recipients; Shortcode/Longcode | Always |
| LinkedID | Identifier for the MO message. This is a Sinch generated ID. | Always |
| TimeStamp | The date and time of the submission of the MO message. This value is in UTC. | Always |
| Priority | The priority (importance) of the message. Possible values: High, Normal, Low | Only when provided by mobile operator |
| Subject | Title of the whole multimedia message. | Only when provided by mobile operator |
| Content | A reference to the content of the MM7 message. Contains an “href:cid” attribute that links to the content ID of the first attachment in the MM7 message. | Only when provided by mobile operator |
| UACapabilities | Information about the capabilities of the MMS user agent that originated,the multimedia message. In this context, the associated timestamp is not populated. | Only when provided by mobile operator |
See the Unsupported MM7 SOAP Elements document for more information.
Example Request
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<soap-env:Envelope xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/" xmlns=
"http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">
<soap-env::Header>
<TransactionID soap-env:mustUnderstand="1">1000001</TransactionID>
</soap-env::Header>
<soap-env::Body>
<DeliverReq>
<MM7Version>6.8.0</MM7Version>
<LinkedID>1000001</LinkedID>
<Sender>
<Number>1617423433</Number>
</Sender>
<Recipients>
<To>
<Number displayOnly="false">111122</Number>
</To>
</Recipients>
<TimeStamp>2014-04-14T16:15:23.414Z</TimeStamp>
<Priority>Normal</Priority>
<Content href="cid:default.cid" allowAdaptations="true"/>
</DeliverReq>
</soap-env:Body>
</soap-env:Envelope>MM7 MO deliver response elements
Your system should respond to the deliver request with a deliver response containing the elements described in the following table.
| Element | Description |
|---|---|
| TransactionID | Identifies the DeliverReq/DeliverRsp pair. It's part of the SOAP header. The value returned is the one provided in the request. |
| DeliverRsp | Identifies the message as a MM7 Deliver Response. |
| MM7Version | Identifies the MM7 Version.(Supported versions are ver-5.3.0 and ver-6.8.0) |
| StatusCode | A code that indicates whether you recieved the MO message request successfully. The status code for successful delivery is 1000. See all MMS status codes. |
| StatusText | Description of the status code. |
Example Response
<?xml version="1.0" encoding="UTF-8" ?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi=
"http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<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>
<DeliverRsp 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 received MMS</StatusText>
</Status>
</DeliverRsp>
</soap-env:Body>
</soap-env:Envelope>Request
POST / HTTP/1.1
SOAPAction: "http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4"
Content-Type: multipart/related; start="soap-start"; type="text/xml";
boundary="----=_Part_139078_1411587550.1397492135426"
Host: api.Mblox.com
Content-Length: 2546
x-mblox-operator-id: 0001890
Connection: Keep-Alive
------=_Part_139078_1411587550.1397492135426
Content-Type: text/xml
Content-ID: <soap-start>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<soap-env:Envelope xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/" xmlns=
"http://www.3gpp.org/ftp/Specs/archive/23_series/23.140/schema/REL-6-MM7-1-4">
<soap-env::Header>
<TransactionID soap-env:mustUnderstand="1">1000001</TransactionID>
</soap-env::Header>
<soap-env::Body>
<DeliverReq>
<MM7Version>6.8.0</MM7Version>
<LinkedID>1000001</LinkedID>
<Sender>
<Number>1617423433</Number>
</Sender>
<Recipients>
<To>
<Number displayOnly="false">111122</Number>
</To>
</Recipients>
<TimeStamp>2014-04-14T16:15:23.414Z</TimeStamp>
<Priority>Normal</Priority>
<Content href="cid:default.cid" allowAdaptations="true"/>
</DeliverReq>
</soap-env:Body>
</soap-env:Envelope>
------=_Part_139078_1411587550.1397492135426
Content-Type: multipart/mixed;
boundary="----=_Part_139079_1300104441.1397492135426"
Content-ID: <default.cid>
------=_Part_139079_1300104441.1397492135426
Content-Type: image/jpeg
Content-Transfer-Encoding: binary
Content-ID: image_0.jpg
<Binary contents>
------=_Part_139079_1300104441.1397492135426
Content-Type: text/plain
Content-Transfer-Encoding: binary
Content-ID: text_0.txt
Test MO message!
------=_Part_139079_1300104441.1397492135426--
------=_Part_139078_1411587550.1397492135426--Response
HTTP/1.1 200 OK
Server: Apache
Content-Type: application/xml; charset=utf-8
Content-Length: 715
Date: Mon, 16 Mar 2015 17:46:59 GMT
<?xml version="1.0" encoding="UTF-8" ?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi=
"http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<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>
<DeliverRsp 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 received MMS</StatusText>
</Status>
</DeliverRsp>
</soap-env:Body>
</soap-env:Envelope>