MIministrybytext
Send

Send SMS, MMS or WhatsApp to a Segment

Changed on

To send an SMS, MMS or WhatsApp to only a few subscribers in a group, you can either upload a CSV file through the Upload file for segment API and attach the file URL in the segment API, attach an array of ListIds, or pass subscriberNumbers in the request body schema.

Audience Resolution Precedence Logic:

  1. If 'segmentSubscriberFileUrl' is provided, the system processes the CSV file and completely ignores both 'listIds' and 'subscriberNumbers'.
  2. If 'segmentSubscriberFileUrl' is null/omitted and 'listIds' is provided, the system delivers the message to the specified segment lists and ignores 'subscriberNumbers'.
  3. If both 'segmentSubscriberFileUrl' and 'listIds' are null/omitted, the system defaults to sending the message directly to the array of numbers provided in 'subscriberNumbers'.

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

Request

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 required

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

Changes

  • ae1e3ddfb2fbRevision changes
    • breaking

      the request property became required

    • info

      added the new optional request property