The sendmms action

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

The sendmms action sends an MMS defined directly in the JSON request to a single mobile number. It is useful when the customer does not need to store and reuse an MMS template.

The MMS may contain one or more slides with text and supported media objects such as image, audio, video, contact, calendar, PDF, and Excel content where enabled for the account. Slides are processed in the order provided in the request, although not all handsets or messaging clients render MMS content in the same way.

All requests are made as HTTPS POST requests with UTF-8 encoded JSON in the request body. Each request must include Content-Type: application/json; charset=utf-8 and the account API key in the x-api-key HTTP header.

Endpoint and headers

POST https://api.ci.mblox.com/ep/v2/
Content-Type: application/json; charset=utf-8
x-api-key: YOUR_API_KEY_HERE

Request parameters

Slide parameters

Fallback SMS considerations

If an MMS is too large to deliver or if a carrier does not support MMS delivery, the API may deliver the content as fallback SMS if enabled. Fallback SMS consists of fallback-sms-text and, by default, a link to view the MMS content.

Group messaging with to-displayonly

Group messaging or group chat display behavior is supported by using the to-displayonly field. The field contains a comma-separated list of phone numbers with country code.

Special considerations

• Always submit destination and sender numbers in international number format. Include the country code and phone number. Do not include dialing prefixes such as 00 or 001 and do not include the plus sign.
• Media URLs must include the full absolute path, including http:// or https://.
• The hosting server must return a valid Content-Length header.
• The hosting server must return a valid Content-Type header.
• Chunked transfer encoding may be rejected if a Content-Length header is not provided.
• Accepted HTTP status codes for media retrieval are 200, 301, 302, 303, 307, and 308.
• For 3xx redirects, only one redirect is followed.
• Each MMS must include at least one slide.
• A maximum of 8 slides per submission is supported in this implementation.
• Each slide may include message-text and one supported media/object type.
• Do not include more than one file of the same MIME type on the same slide.
• Image slides may include audio and text, but not video.
• Audio slides may include text, but not video.
• Video slides may include text, but not image or audio.
• Object slides such as contact, calendar, PDF, and Excel should not be combined with image, audio, or video.

Example: Send MMS without group messaging

curl -i -X POST \
  https://api.ci.mblox.com/ep/v2/ \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "action": "sendmms",
    "service-id": "campaign-123",
    "to": "17745550001",
    "from": "18885551234",
    "message-subject": "Deal of the Day",
    "fallback-sms-text": "We could not deliver the MMS. View it here:",
    "disable-fallback-sms": false,
    "disable-fallback-sms-link": false,
    "client-reference": "order-12345",
    "slide": [
      {
        "image": {
          "url": "https://example.com/content/deal.png"
        },
        "message-text": "Hello! Here is today's deal."
      }
    ]
  }'

Example: Send MMS with group messaging display

curl -i -X POST \
  https://api.ci.mblox.com/ep/v2/ \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "action": "sendmms",
    "service-id": "campaign-123",
    "to": "17745550001",
    "to-displayonly": "17745550002,17745550003",
    "from": "18885551234",
    "fallback-sms-text": "We could not deliver the MMS. View it here:",
    "disable-fallback-sms": false,
    "slide": [
      {
        "image": {
          "url": "https://example.com/content/group-image.jpg"
        },
        "message-text": "Team reminder: the event starts at 6 PM."
      }
    ]
  }'

Success response example

{
  "status": "success",
  "tracking-id": "abc123xyz",
  "to": "17745550001",
  "from": "18885551234",
  "status-details": "MMS request accepted and queued for delivery."
}

Failure response example

{
  "status": "failure",
  "error-code": "E111",
  "error-info": "Invalid Sender."
}

Response schema