MMS
Send & Receive Rich Content MMS easily via API
Introduction
This document provides a reference for all features available to you via the MM7 interface for sending MMS messages. The MM7-API allows you to integrate your Application (Client) to SMSGlobal (Vendor) allowing you to send MMS messages via the MM7 protocol.
The MM7 protocol is based on the concept of Web Services and uses SOAP and HTTP for communication. The multimedia messages are sent to the MMS.
Relay/Server with HTTP POST method. The body of the post contains XML data about the delivery and the MMS message as a MIME-multipart attachment.
Server Details Scroll to Top ▲
| Parameter | Description |
|---|---|
| IP/DOMAIN | https://api.smsglobal.com/mms/mm7.php |
| PORT | 443 |
| SYSTEM ID | [ Username ] |
| PASSWORD | [ Password ] |
Sending MMS Messages Scroll to Top ▲
URL: https://api.smsglobal.com/mms/sendmms.php
HTTP Request Scroll to Top ▲
| Parameter | Description | Options | Description |
|---|---|---|---|
| username | Your SMSGlobal username | Mandatory | |
| password | Your SMSGlobal username | Mandatory | |
| from | MSIDSN that the message will appear from. Use this only if you have a dedicated number with SMS Global. | Optional | |
| number | MSIDSN of the recipient that the message will be sent to. Eg: 61409317436 (Do not use + before the country code) | Mandatory | |
| subject | Subject of message | Optional | |
| message | Message to be sent. Must be URL encoded. | Optional | |
| max_dimension | Maximum resolution of attached pictures. Defaults to 1024 pixels. | Optional | |
| message_at_start | Defines whether text portion of message is at the start or end. Values: 1/0. Defaults to start (1). | Optional | |
| attachmentx | Attachment, where X is the attachment number 0 <= X < 15 (base64 encoded) | Mandatory for each attachment | |
| typex | Attachment type, where X is the attachment number eg. image/jpeg | Mandatory for each attachment | |
| namex | Attachment name, where X is the attachment number eg. image1.jpg | Mandatory for each attachment |
Note: MMS messaging isn’t bound by the same size limitation as SMS. MMS messages are limited to 300kb in total, therefore depending on the size of any attachments in your message, the amount of text you will be able to send will be reduced.
HTTP Response Scroll to Top ▲
| Parameter | Description |
|---|---|
| SUCCESS | Success. ID = {Message_id}; (message_id is a unique 16-digit integer identifying the message.) |
| FAILURE | Your SMSGlobal username |
Supported File Formats Scroll to Top ▲
File below a file format compatibility table.
| File Type | Media Type | Compatibility / Support |
|---|---|---|
| Images | ||
| JPEG, JPG | (image/jpeg) | Good support |
| GIF: GIF87a, GI89a, animated GIF89a | GIF89a (image/gif) | This is B&W image format from the old days of WAP |
| BMP (Windows Bitmap) | (image/bmp) | Dependent on handset support |
| Audio | ||
| MP3 | (audio/mpeg) | Partial support; some handsets may limit the use of the file due to DRM concerns by the manufacturer |
| MID, MIDI | (audio/mid or audio/midi) | Good support |
| WAV | (audio/wav) | Good support |
| AMR | (audio/amr) | Partial support, GSM handsets only |
| IMY, eMY | (audio/imelody) | Partial support |
| Evc | - | Not currently supported |
| AAC | - | Not currently supported |
| Video | ||
| MPeG, MPG, MP4 | (video/mpeg4) | Support may vary by handset |
| 3GP | (video/3gpp) | Good support |
| Text | ||
| TXT, TeXT, US-ASCII | UTF-8, US-ASCII (not UTF-16) (text/plain) | Good support |
| X-IMeLODY | (text/x-imelody) | Partial to good |
| X-eMeLODY | (text/x-emelody) | Partial to good |
Note: In order to maximise the chances of delivery success, SMSGlobal attempts to transcode files to a suitable format supported by the end device.
Error Codes Scroll to Top ▲
| Status Code | Status Text | Description |
|---|---|---|
| 0 | Connection error | Indicates a connection error with the MMS Relay/Server |
| 1000 | Success | Indicates the request completed successfully |
| 1100 | Partial success | Indicates only some parts of the request were completed successfully. (e.g. some for a multi-recipient message some destinations could not be resolved). Please note, multiple recipients are not currently supported. |
| 2000 | Client error | MM7 Client made an invalid request. |
| 2001 | Operation restricted | Your Account does not have permission to use this feature. |
| 2002 | Address Error | The formatting of one or more of the addresses was not valid (should be MSISDN or email address). |
| 2003 | Address Not Found | The address supplied in the request could not be located by Access Manager. This code is returned when an operation is requested on a previously submitted message and Access Manager cannot find the message for the address specified. |
| 2004 | Multimedia | The server could not parse the MIME content that was attached to the SOAP message and indicated by the Content element or the content size or media type was unacceptable. Additionally it may be a content type not allowed by Access Manager |
| 2005 | Message ID Not found | Returned when an operation is requested on a previously submitted message which cannot be found. |
| 2006 | LinkedID not found | This code is returned when a LinkedID was supplied and Access Manager could not find the related message. |
| 2007 | Message format corrupt | An element value format is inappropriate or incorrect. |
| 2008 | Application ID not found | Your MM7 credentials are not valid. |
| 2009 | Reply Application ID not found | This code is returned when a Reply Application ID was supplied and Access Manager could not find the originating application. |
| 3000 | Server Error | Access Manager failed to fulfill an apparently valid request. |
| 3001 | Not Possible | The request could not be carried out because it is not possible. This code is normally used as a result of a cancel or status query on a message that is no longer available for cancel or status query. Access Manager has recognized the message in question, but it cannot fulfill the request because the message is already complete or status is no longer available. |
| 3002 | Message Rejected | Server could not complete the service requested. |
| 3003 | Multiple addresses not supported | Access Manager does not support this operation on multiple recipients. The operation MAY be resubmitted as multiple single recipient operations. |
| 3004 | Application Addressing not supported | Recipient MMS User Agent does not support the transport of application data. |
| 4000 | General service error | The requested service cannot be fulfilled. |
| 4001 | Improper identification | Identification header of the request does not uniquely identify the client (either the VASP or MMS Relay/Server). |
| 4002 | Unsupported version | The version indicated by the MM7 Version element is not supported. |
| 4003 | Unsupported version | The server does not support the request indicated by the MessageType element in the header of the message. |
| 4004 | Validation error | The SOAP and XML structures could not be parsed,mandatory fields are missing, or the message-format is not compatible to the format specified. Details field may specify the parsing error that caused this status. |
| 4005 | Service error | The operation caused a failure within Access Manager and should not be resent. |
| 4006 | Service unavailable | This indication may be sent by the server when service is temporarily unavailable, e.g. when server is busy |
| 4007 | Service denied | The client does not have permission or funds to perform the requested operation. |
| 4008 | Application denied | The application does not have permission or funds to perform the requested operation. |
Incoming MMS Scroll to Top ▲
If you would like notification of your Incoming MMS to be pushed to your server, please contact SMSGlobal support at support@smsglobal.com and we’ll update your MMS messaging preferences.
In order for our system to know that your URL has received the delivery notice, at the end of your script you must echo out “OK”.
Please find below the list of parameters that are sent.
| Parameter | Description |
|---|---|
| from | Mobilie Originated Number (MMS Sender) |
| subject | Subject sent in MMS Message |
| message | Text portion of the MMS Message |
| id | Internal ID, used for tracking |
| attachmentx | Attachment, where X is the attachment number. |
| content_typex | Content type of attachment, where X is attachment number. Example, image/jpeg |
| content_namex | Content name of attachment, where X is attachment number. Example, image1.jpg |
When the message has been received and accepted by your server it is required that you echo the statement ‘OK’ to stop further pushes by SMSGlobal.