--- title: "Send SMS message" method: POST path: "/sms/3/messages" tags: ["channels", "sms", "outbound-sms", "send-message"] --- # Send SMS message `POST /sms/3/messages` ## Request - Base URL: `https://api.infobip.com` (the document declares no server; this is the origin it was published from) - URL: `https://api.infobip.com/sms/3/messages` - Auth: one of: - OAuth 2 - Client credentials - Token URL: `https://api.infobip.com/auth/1/oauth2/token` - API key in header `Authorization` - API key in header `Authorization` - HTTP basic With this API method, you can do anything from sending a basic message to one person, all the way to sending customized messages to thousands of recipients in one go. It comes with a range of useful features like transliteration, scheduling, and tracking in a unified way.\ If utilizing Message Delivery Reports webhook, please consult the documentation provided at [Receive outbound SMS message reports](#channels/sms/receive-outbound-sms-message-report-v3).\ This endpoint is the successor of [Send SMS message](#channels/sms/send-sms-message) and [Send binary SMS message](#channels/sms/send-binary-sms-message). ## Request body - 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630SmsRequestEnvelope - `messages` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630SmsMessage[], required: An array of message objects of a single message or multiple messages sent under one bulk ID. - `sender` string: 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). - `destinations` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630SmsToDestination[], required: An array of destination objects for where messages are being sent. A valid destination is required. - `to` string, required: The destination address of the message. - `messageId` string: The ID that uniquely identifies the message sent. - `networkId` integer: Available in US and Canada only if networkId is known for Network Operator of the destination. Returned in [SMS message delivery reports](https://www.infobip.com/docs/api/channels/sms/sms-messaging/logs-and-status-reports) and [Inbound SMS](https://www.infobip.com/docs/api/channels/sms/sms-messaging/inbound-sms); contact Infobip Support to enable. - `content` union, required: Message content. - object - `text` string, required: Content of the message being sent. - `transliteration` 'NONE' | 'TURKISH' | 'GREEK' | 'CYRILLIC' | 'SERBIAN_CYRILLIC' | 'CENTRAL_EUROPEAN' | 'BALTIC' | 'NON_UNICODE' | 'PORTUGUESE' | 'COLOMBIAN' | 'BULGARIAN_CYRILLIC' | 'ALL': The transliteration of your sent message from one script to another. [Transliteration](https://www.infobip.com/docs/sms/language#sms-transliteration) is used to replace characters which are not recognized as part of your defaulted alphabet. `ALL` means that the transliteration process will recognize all supported languages. - `language` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630SmsLanguage: Sets the language parameters for the message being sent. - `languageCode` 'NONE' | 'TR' | 'ES' | 'PT' | 'AUTODETECT': [Language code](https://www.infobip.com/docs/sms/language#national-language-identifier) for the correct character set. `AUTODETECT` lets the platform select the character set based on message content only for supported languages. - `singleShift` boolean: Uses a single shift table which enhances only the extension table of the GSM default alphabet. Allows you to selectively improve character support without altering the entire message. - `lockingShift` boolean: Uses a locking shift table which allows you to represent characters beyond the standard GSM default alphabet. This flexibility enables better language support. - object - `dataCoding` integer: Binary content data coding. The default value is (`0`) for GSM7. Example: (`8`) for Unicode data. - `esmClass` integer: “Esm_class” parameter. Indicate special message attributes associated with the SMS. Default value is (`0`). - `hex` string, required: Hexadecimal string. This is the representation of your binary data. Two hex digits represent one byte. They should be separated by the space character. - `options` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630SmsMessageOptions: Message options. - `platform` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630Platform: Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management). - `entityId` string: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management). - `applicationId` string: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management). - `validityPeriod` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630ValidityPeriod: 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. - `amount` integer, required: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`. - `timeUnit` 'SECONDS' | 'MINUTES' | 'HOURS': Message validity period time unit. - `deliveryTimeWindow` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630DeliveryTimeWindow: 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. - `days` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630DeliveryDay[], required: 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` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630DeliveryTime: The exact time of the day. The time is expressed in the UTC time zone. - `hour` integer, required: Hour when the time window opens when used in the `from` property or closes when used in the `to` property. - `minute` integer, required: Minute when the time window opens when used in the `from` property or closes when used in the `to` property. - `to` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630DeliveryTime: The exact time of the day. The time is expressed in the UTC time zone. - `hour` integer, required: Hour when the time window opens when used in the `from` property or closes when used in the `to` property. - `minute` integer, required: Minute when the time window opens when used in the `from` property or closes when used in the `to` property. - `campaignReferenceId` string: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel. - `regional` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630RegionalOptions: 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` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630IndiaDltOptions: 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` string, required: Your assigned DLT principal entity ID. - `telemarketerId` string: Your assigned Telemarketer ID. (required for Aggregators) - `turkeyIys` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630TurkeyIysOptions: IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey. - `brandCode` integer: 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` 'BIREYSEL' | 'TACIR', required: Recipient Type must be `TACIR` or `BIREYSEL`. - `southKorea` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630SouthKoreaOptions: Use case dependent parameters for sending SMS to phone numbers registered in South Korea. - `title` string: Title of the message. - `resellerCode` integer: Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending. - `flash` boolean: 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. - `webhooks` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630Webhooks: Provides options for configuring message webhooks. - `delivery` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630MessageDeliveryReporting: Provides options for configuring the delivery report behavior. - `url` string: The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`. - `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`. - `notify` boolean: Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to 'true' or not defined, your Subscription settings will apply. - `contentType` string: Preferred delivery report content type, `application/json` or `application/xml`. - `callbackData` string: 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` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630SmsMessageRequestOptions: Options applicable to all messages in the request. - `schedule` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630RequestSchedulingSettings: Options for scheduling a message. - `bulkId` string: 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. - `sendAt` string, date-time: 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. - `sendingSpeedLimit` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630SendingSpeedLimit: 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` integer, required: 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` 'MINUTE' | 'HOUR' | 'DAY': The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`. - `tracking` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630UrlOptions: Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature. - `shortenUrl` boolean: Enable shortening of the URLs within a message. Set this to `true`, if you want to set up other URL options. - `trackClicks` boolean: 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: 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. - `includeSmsCountInResponse` boolean: 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. - `conversionTracking` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630Tracking: 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). - `useConversionTracking` boolean: Indicates if a message has to be tracked for conversion rates. Default "false". - `conversionTrackingName` string: Sets a custom conversion type naming convention, e.g. `ONE_TIME_PIN` or `SOCIAL_INVITES`. ## Response `200` OK - 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630SmsResponseEnvelope - `bulkId` string: 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 for fetching delivery reports and message logs. - `messages` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630MessageResponseSmsMessageResponseDetails[], required: An array of message objects of a single message or multiple messages sent under one bulk ID. - `messageId` string: Unique message ID. If not provided, it will be auto-generated and returned in the API response. - `status` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630MessageStatus: Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any. - `groupId` integer: Status group ID. - `groupName` 'ACCEPTED' | 'PENDING' | 'UNDELIVERABLE' | 'DELIVERED' | 'EXPIRED' | 'REJECTED': Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes). - `id` integer: Status code ID. - `name` string: [Status code](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) name. - `description` string: Human-readable description of the status. - `action` string: Action to take to recover from the error. - `destination` string: The destination address of the message, i.e., its recipient. - `details` 20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630SmsMessageResponseDetails: Other details of the message. - `messageCount` integer: Number of SMS message parts required to deliver the message. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `500`: Internal Server Error --- [API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)