SendTransactionalSms

SendTransactionalSms function sends transactional mobile text messages to recipients.

There are two type of content to send transactional sms.

Payload-1 (use content)

In this method, the client sends the content and recipients. The system returns uuid-type transactionalIds per recipient and uuid-type groupId for all.

These transactional ids are used to get the report per recipient whereas the groupId response field is used to get the report of all recipient at once.

For multi language send, the multiLangContent property should be used.

Payload-2 (use template)

This method is used to send transactional mobile text messages using an existing template in the system. The only difference from Method-1 is templateId field is used to select the template from the system. This templateId can be created both using API (CreateSmsContent) or through GUI.

For multi language send, a template id created as multi language should be selected.

** You cannot use multiLangContent and content properties at the same time.

Recipients language can be used as a parameter for sending with multi language content if recipient language is given, this property used as a user language otherwise contact language is used.

Link Shortening and Click Tracking

The system can automatically shorten URLs in your SMS messages and track click events:

• When using templateId: If the template has 'Shorten and track links' feature enabled in the system, link shortening and click tracking will be automatically applied. No additional parameter is needed.
• When using message: Use the enableShortlink parameter within the content object (for single language) or within each item of the multiLangContent.contents array (for multi-language). Set it to true to enable link shortening and click tracking, or false to disable it.

Earliest Time and Latest Time
If the earliestTime or latestTime property is empty, used as a partner default values.
Content specific earliestTime or latestTime can be used for each content in sendings with multilanguage.
Or base earliestTime or latestTime property which is defined under which is defined under root property, can be used for all contents inside of the multilanguage contents.

Idempotency Support: This endpoint supports idempotency via the optional traceId parameter. For more information, see Rest API Idempotency.