v1

latestOpenAPI 3.0.12026-08-0640103344.9 KB

Send

Send SMS, MMS or WhatsApp to subscribers of a group

Dispatches a one-time message broadcast, test message, unicast message, or two-way interactive chat message to subscribers within one or more groups. Supports multi-channel delivery including SMS, MMS (requires pre-uploading media files to attach a valid 'mediaPath'), and WhatsApp (requires an approved WhatsApp template layout).

1 SMS = 1 Message Credits
1 MMS = 3 Message Credits
1 WhatsApp = Region based charges from wallet

post/orgunit/{orgunitId}/messages

Path parameters

orgunitIdstring required

orgunitId

Request body

groupIdstring[]

An array of unique groupIds targeting the subscriber lists that will receive this message.

fromstring

The sending entity identifier or group name displayed to the recipient in the message's start.

messagestring

The raw text payload to be delivered to subscribers. Leave empty or omit if you are utilizing a pre-configured template layout via 'templateId'.

templateIdstring

The unique identifier of a message template. When passed, the system will deliver the structured template message layout. For sending WHATSAPP broadcast, this field is mandatory.

subscriberMobileNostring[] nullable

An array of specific destination mobile phone numbers. Used to isolate delivery to individual subscribers instead of the entire group list. Mandatory for messageType Test, Twoway and Unicast

messageType'Test' | 'BroadcastMessage' | 'Twoway' | 'Unicast'

Defines the operational intent of the transmission. Valid values are: 'Test' (internal verification), 'BroadcastMessage' (mass campaign), 'Twoway' (one-to-one interactive chat), or 'Unicast' (targeted multi-number delivery).

referenceIdstring nullable

An optional external tracking or transaction identifier used to correlate this transmission with your internal database records.

autoSubscribeboolean

When set to true, automatically opts in and subscribes any phone numbers provided in 'subscriberMobileNo' to the targeted group if they are not already members.

channelType'SMS' | 'MMS' | 'WHATSAPP'

Specifies the target communication network channel for delivery. Accepted values include SMS, MMS, or WHATSAPP.

Response

Success

appCodestring nullable

messagestring nullable

isErrorboolean