Sign in

v1

latestOpenAPI 3.0.12026-08-0640103344.9 KB
Send

Send SMS, MMS or WhatsApp to a Segment

To send an SMS, MMS or WhatsApp to only few subscribers in a group, you can either upload a csv file through Upload file for segment API and attach the file url in segment API or pass subscriberNumbers in request body schema. If csv file url is attached, then subscriberNumbers parameters will not be accepted and the message will be sent to only the subscribers in the file. If csv file url is not passed, then message will be sent to subscriberNumbers list.

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).

post/orgunit/{orgunitId}/groups/{groupId}/messages/segment

Path parameters

orgunitIdstring required

orgunitId

groupIdstring required

groupId

Request body

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 nullable

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.

type'BroadcastMessage'
referenceIdstring nullable

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

subscriberNumbersstring[] nullable

An array of specific destination mobile phone numbers. Used to isolate delivery to individual subscribers instead of the entire group list.

segmentSubscriberFileUrlstring nullable

Url of csv file containing specific destination mobile phone numbers. Used to isolate delivery to individual subscribers instead of the entire group list.

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