MMS - Send MMS

post

https://partner-api-url.com/send-mms

Send MMS. Returns 200 OK on successful send. On failure, we distinguish between permanent and temporary errors. Status codes above 500 and also 429 will be retried later. Other non-200 status codes will result in the enqueue_failed event.

🚧
Disclaimer: Intended Use of Channel API
The Channel API documentation is designed exclusively for partners who have established commercial agreements with Bloomreach, including CPaaS vendors (Communications Platform as a Service) and MTAs (Mail Transfer Agents, also known as ESPs), such as Mailgun, Sinch, Infobip, Omnivery and others. This API enables our partners to build connectors to their systems effectively and aligns with our service offerings.
Please note that this API is not intended for general client use. If you are an existing client and are interested in Channel API, please contact your account manager.

Body Params

subject

string

required

Subject line

fallback_sms

string

required

Fallback message sent in case target device does not support MMS

media

object

required

sender

string

required

Sender number or name

recipient

string

required

Recipient number, format 00\d{7,15} (MSISDN)

message

string

required

Message content

request_id

string

required

Unique request ID which can be used for deduplication. This may be the only way to ensure exactly-once delivery in case of send endpoint timeouts.

custom_data

string

required

Custom obscure BR data metadata which need to be stored on provider's side, passed to webhook callbacks. Will be URL safe and usually a few hundred characters long.

callback_url

string

required

Webhook URL where to send delivery reports along with custom_data.

metadata

object

required

BR metadata that can be used by provider if needed

Headers

Chan-Example-Token

string

required

Defaults to 123

An example header (one of multiple) containing account identity or authorization data. The actual headers to be sent can be customized to provider's needs, by default BR will send each setting field as a separate header with the prefix Chan- added to the name.

An API key is a token that you provide when making API calls. Include the token in a header parameter called Chan-Example-Token.

Example: Chan-Example-Token: 123

Responses

Disclaimer: Intended Use of Channel API

200200

4XX4XX

5XX5XX