Fully featured textual message

POST https://{baseUrl}/sms/2/text/advanced

This is your first endpoint! Edit this page to start documenting your API.

Response

If successful, response header HTTP status code will be 200 OK and the message will be sent. If you try to send the message without authorization, you will receive an 401 Unauthorized error.

Request Headers

Header	Type	Description	Required
Content-Type	string	Should be "application/json".	Yes
Authorization	string	API key for authentication (Bearer <your_api_key>).	Yes

Request Body

Root Object

Field	Type	Description	Required
bulkId	string	Unique identifier for the bulk request.	No
messages	array<object>	List of message objects.	Yes
tracking	object	Tracking details for the message batch.	No

messages (Array of Objects)

Field	Type	Description	Required
callbackData	string	Data sent in the delivery report callback.	No
destinations	array<object>	List of message recipients.	Yes
flash	boolean	Indicates if the message should be sent as a flash SMS.
from	string	Sender name or number.	Yes
intermediateReport	boolean	Whether intermediate delivery reports should be sent.	No
language	object	Language settings for the message.	No
notifyContentType	string	Content type for notifications.	No
notifyUrl	string	URL for delivery report callbacks.	No
text	string	Message text content.	Yes
transliteration	string	Defines transliteration settings for special characters.	No
validityPeriod	integer	Message validity period in minutes.	No
campaignReferenceId	string	Identifier for a campaign-related message.	No
sendAt	string (ISO 8601)	Scheduled time for sending the message.	No
deliveryTimeWindow	object	Specifies time restrictions for message delivery.	No

destinations (Array of Objects)

Field	Type	Description	Required
messageId	string	Unique identifier for the message.	No
to	string	Recipient phone number in international format.	Yes

language Object

Field	Type	Description	Required
languageCode	string	Language code (e.g., "TR" for Turkish).	Yes

deliveryTimeWindow Object

Field	Type	Description	Required
days	array<string>	List of allowed delivery days (e.g., "MONDAY", "TUESDAY").	Yes
from	object	Start time for delivery window.	Yes
to	object	End time for delivery window.	Yes

from/to Objects (Inside deliveryTimeWindow)

Field	Type	Description	Required
hour	integer	Hour of the day (0-23).	Yes
minute	integer	Minute of the hour (0-59).	Yes

tracking Object

Field	Type	Description	Required
track	string	Tracking type (e.g., "SMS").	Yes
type	string	Custom tracking identifier.	No