Use this endpoint to send an SMS and set up a rich set of features, such as batch sending with a single API request, scheduling, URL tracking, language and transliteration configuration, etc. The API response will not contain the final delivery status, use Delivery Reports instead. In light of improved features, this endpoint has been superseded. Please visit Send SMS message for the next version.
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. Typically, used to fetch delivery reports and message logs. Anything above 100 characters passed in the request will be clipped during processing and returned in response, reports and logs.
messages
required
Array of objects
An array of message objects of a single message or multiple messages sent under one bulk ID.
Array
callbackData
string [ 0 .. 4000 ] characters
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.
deliveryTimeWindow
object
Sets specific SMS delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent.
Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
from
object
The exact time of day to start sending messages. Time is expressed in the UTC time zone. If set, use it together with the to property with minimum 1 hour difference.
hour
required
integer <int32> [ 0 .. 23 ]
Hour when the time window opens when used in the from property or closes when used in the to property.
minute
required
integer <int32> [ 0 .. 59 ]
Minute when the time window opens when used in the from property or closes when used in the to property.
to
object
The exact time of day to end sending messages. Time is expressed in the UTC time zone. If set, use it together with the from property with minimum 1 hour difference.
hour
required
integer <int32> [ 0 .. 23 ]
Hour when the time window opens when used in the from property or closes when used in the to property.
minute
required
integer <int32> [ 0 .. 59 ]
Minute when the time window opens when used in the from property or closes when used in the to property.
destinations
required
Array of objects
An array of destination objects for where messages are being sent. A valid destination is required.
Array
messageId
string
The ID that uniquely identifies the message sent. Anything above 200 characters passed in the request will be clipped during processing and returned in response, reports and logs.
to
required
string [ 0 .. 64 ] characters
Message destination address. Addresses must be in international format (Example: 41793026727).
flash
boolean
Default: false
Allows for sending a 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.
from
string
The sender ID which can be alphanumeric or numeric (e.g., CompanyName). Make sure you don't exceed character limit.
intermediateReport
boolean
The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to false.
language
object
languageCode
string
Language code for the correct character set. Possible values: TR for Turkish, ES for Spanish, PT for Portuguese, or AUTODETECT to let platform select the character set based on message content.
notifyContentType
string
Preferred delivery report content type, application/json or application/xml.
notifyUrl
string
The URL on your call back server on to which a delivery report will be sent. The retry cycle for when your URL becomes unavailable uses the following formula: 1min + (1min * retryNumber * retryNumber).
Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
indiaDlt
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
contentTemplateId
string
Registered DLT content template ID which matches message you are sending.
principalEntityId
required
string
Your assigned DLT principal entity ID.
telemarketerId
string
Your assigned Telemarketer ID. (required for Aggregators)
turkeyIys
object
IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
brandCode
integer <int32>
Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
recipientType
required
string
Enum:"BIREYSEL""TACIR"
Recipient Type must be TACIR or BIREYSEL.
southKorea
object
Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
resellerCode
integer <int32>
Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.
title
string [ 0 .. 66 ] characters
Set the title or subject of a message. South Korea only.
sendAt
string <date-time>
Date and time when the message is to be sent. Used for scheduled SMS. 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.
text
string
Content of the message being sent.
transliteration
string
The transliteration of your sent message from one script to another. Transliteration is used to replace characters which are not recognized as part of your defaulted alphabet. Possible values: TURKISH, GREEK, CYRILLIC, SERBIAN_CYRILLIC, BULGARIAN_CYRILLIC, CENTRAL_EUROPEAN, BALTIC, PORTUGUESE, COLOMBIAN, and NON_UNICODE.
validityPeriod
integer <int64>
The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported. Any bigger value will automatically default back to 2880.
entityId
string [ 0 .. 50 ] characters
Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our documentation.
applicationId
string [ 0 .. 50 ] characters
Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our documentation.
campaignReferenceId
string [ 0 .. 255 ] characters
ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
sendingSpeedLimit
object
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.
amount
required
integer <int32>
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.
timeUnit
string
Default: "MINUTE"
Enum:"MINUTE""HOUR""DAY"
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
Enable shortening of the URLs within a message. Set this to true, if you want to set up other URL options.
trackClicks
boolean
Default: true
Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom.
trackingUrl
string
The URL of your callback server on to which the Click report will be sent.
removeProtocol
boolean
Default: false
Remove a protocol, such as https://, from links to shorten a message. Note that some mobiles may not recognize such links as a URL.
customDomain
string
Select a predefined custom domain to use when generating a short URL.
tracking
object
Sets up tracking parameters to track conversion metrics and type. This is a legacy feature not compatible with the tracking feature in latest Send SMS message API.
baseUrl
string
Custom base URL for shortened links in messages when tracking URL conversions. Legacy - use urlOptions instead.
processKey
string
The process key which uniquely identifies conversion tracking.
track
string
Indicates if a message has to be tracked for conversion rates. Values are: SMS and URL. URL is a legacy value. Use urlOptions instead. For more details on SMS Conversion, see: Track Conversion.
type
string
Sets a custom conversion type naming convention, e.g. ONE_TIME_PIN or SOCIAL_INVITES.
includeSmsCountInResponse
boolean
Default: false
Set to true to return smsCount in the response. Default is false. smsCount is the total count of SMS submitted in the request. SMS messages have a character limit and messages longer than that limit will be split into multiple SMS and reflected in the total count of SMS submitted.
Service status'%3E %3Cpath d='M11.9047 8.47667L19.3513 0H17.5873L11.1187 7.35867L5.956 0H0L7.80867 11.1287L0 20.0167H1.764L8.59067 12.244L14.044 20.0167H20M2.40067 1.30267H5.11067L17.586 18.778H14.8753' fill='%23424B5C'/%3E %3C/g%3E %3Cdefs%3E %3CclipPath id='clip0_3438_1744'%3E %3Crect width='20' height='20.0167' fill='white'/%3E %3C/clipPath%3E %3C/defs%3E %3C/svg%3E)
