The sendsavedmms 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

This action sends the saved MMS template, specified by an mms-id, to a single mobile number. The sender number must be one of the shortcodes/longcodes allowed for your account. The receiver number must be within the same country as the selected shortcode/longcode.

Fallback SMS considerations

If the MMS message is too large to be delivered or the carrier does not support MMS delivery, the API has an option to facilitate MMS delivery as fallback SMS. The fallback SMS consists of two parts: the fallback SMS text and the fallback SMS link.

The fallback SMS text

The fallback SMS text is the SMS text that will be sent instead of the MMS. The fallback SMS link, used to view the MMS content, is also sent. You can dynamically change the fallback SMS text by populating the fallback-sms-text field. If disable-fallback-sms is set node is set to true, then the fallback SMS text is not required. By default, the fallback SMS is enabled. If the MMS was attempted to be sent as SMS and the fallback SMS is disabled, the message sending will fail.

The fallback SMS link

The fallback SMS link is the link that hosts the MMS content. The fallback SMS link may be disabled by setting disable-fallback-sms-link to true; in this case only the fallback SMS text is sent. By default, we always send the fallback SMS link along with the fallback SMS text.

The fallback SMS link expiration defines how long the MMS sent as SMS using this mms-id is valid and viewable on the mobile browser. By default, it is set to one year if no value is passed. The maximum expiration duration cannot be more than one year.

Special considerations

• Always use international number format. You must use the international format when sending MMS. International format includes both the country code and the phone number. We use the country code to determine routing of the message. There should be no dialing prefixes (for example, no 00 or 001). For example, the US number 774-555-9144 in international number format would be 17745559144 because the USA country code is 1.

• You can dynamically send custom text for each slide by populating the custom-slides object. Any custom-slides object must include the custom-message-text and custom-slide fields. Line breaks are supported in the custom slide texts of the MMS.

Sample payload and response

curl -i -X POST \
  https://api.ci.mblox.com/ep/v2/ \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "value": {
      "action": "sendsavedmms",
      "mms-id": "MMS_TEMPLATE_ID",
      "service-id": "YOUR_CAMPAIGN_ID",
      "to": "RECIPIENT_PHONE_NUMBER_WITH_COUNTRY_CODE",
      "from": "YOUR_PHONE_NUMBER",
      "from-mask": "YOUR_MASK",
      "message-subject": "YOUR_SUBJECT_TEXT",
      "fallback-sms-text": "TEXT_OF_FALLBACK_SMS",
      "disable-fallback-sms": false,
      "disable-fallback-sms-link": false,
      "mms-expiry-timestamp": "MMS_EXPIRY_TIMESTAMP_UTC",
      "client-reference": "CLIENT_SUPPLIED_IDENTIFIER",
      "custom-slides": [
        {
          "custom-message-text": "CUSTOM_MESSAGE_TEXT",
          "custom-slide": "CUSTOM_SLIDE_NUMBER"
        }
      ]
    }
  }'

Request schema

Response schema