channels
sms
outbound-sms
send-message

Send SMS message over query parameters

All message parameters of the message can be defined in the query string. Use this method only if Send SMS message is not an option for your use case!<br>Note: Make sure that special characters and user credentials are properly encoded. Use a URL encoding reference as a guide.

get/sms/1/text/query

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    none required

Query parameters

usernamestring required

Username for authentication.

passwordstring required

Password for authentication.

bulkIdstring

Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. Anything above 100 characters passed in the request will be clipped during processing and returned in response, reports and logs.

fromstring

The sender ID which can be alphanumeric or numeric (e.g., CompanyName).

tostring[] required

List of message recipients.

textstring

Content of the message being sent.

flashboolean

Sends a flash SMS if set to true.

transliterationstring

Conversion of a message text from one script to another.

languageCodestring

Code for language character set of a message content.

intermediateReportboolean

Use a real-time intermediate delivery report that will be sent on your callback server.

notifyUrlstring

The URL on your call back server on to which a delivery report will be sent.

notifyContentTypestring

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

callbackDatastring

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.

validityPeriodinteger

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.

sendAtstring 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. Must be sooner than 180 days from now.

trackstring

Sets the conversion element to be tracked. Possible values: SMS and URL. For more details on SMS Conversion, see: Track Conversion.

processKeystring

The process key which uniquely identifies conversion tracking.

trackingTypestring

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

indiaDltContentTemplateIdstring

The ID of your registered DLT (Distributed Ledger Technology) content template.

indiaDltPrincipalEntityIdstring

Your DLT (Distributed Ledger Technology) entity id.

indiaDltTelemarketerIdstring

Your assigned Telemarketer ID. (required for Aggregators)

turkeyIysBrandCodeinteger

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.

turkeyIysRecipientTypestring

Recipient Type must be TACIR or BIREYSEL

southKoreaResellerCodeinteger

Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.

Response

Successful response

bulkIdstring

The ID that uniquely identifies the request. Bulk ID will be received only when a message is sent to more than one destination address.

Changes

No recorded changes to this operation across all 1 revision of this API.