Send SMS Message

Comma-separated response fields to include.

An array of message objects of a single message or multiple messages sent under one bulk ID.

The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).

An array of destination objects for where messages are being sent. A valid destination is required.

Message content.

Message options.

Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).

Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.

Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.

ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.

Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.

Allows for sending a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) to automatically appear on recipient devices without interaction. Set to `true` to enable flash SMS, or leave the default value, `false` to send a standard SMS.

Provides options for configuring message webhooks.

Provides options for configuring the delivery report behavior.

Preferred delivery report content type, `application/json` or `application/xml`.

Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.

Options applicable to all messages in the request.

Options for scheduling a message.

Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response.

Date and time when the message is to be sent. Used for scheduled messages. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, and can only be scheduled for no later than 180 days in advance.

Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.

The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches.

The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`.

Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.

Enable shortening of the URLs within a message. Set this to `true`, if you want to set up other URL options.

Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom.

The URL of your callback server on to which the Click report will be sent.

Remove a protocol, such as `https://`, from links to shorten a message. Note that some mobiles may not recognize such links as a URL.

Select a predefined custom domain to use when generating a short URL.

Set to true to return `messageCount` in the response. The `messageCount` is the total count of SMS submitted in the request. SMS messages have a character limit and messages longer than the limit will be split into multiple SMS. Not compatible with `binary` message content type.

Allows you to set up tracking parameters to track conversion metrics. For more details, see: [SMS with conversion tracking](https://www.infobip.com/docs/sms/sms-over-api#send-sms-with-conversion-tracking).

Indicates if a message has to be tracked for conversion rates. Default "false".

Sets a custom conversion type naming convention, e.g. `ONE_TIME_PIN` or `SOCIAL_INVITES`.