v1

latestSwagger 2.02026-08-06114161439.7 KB

SMS Broadcast

Create SMS broadcast from contacts

Create a new SMS broadcast by selecting individual contacts or entire contact lists. Either contact_ids or contact_list_ids must be provided, but not both.

post/broadcasts

Request body

broadcast_namestring required

Human-readable broadcast campaign name. String.

tracking_numberstring required

Phone number the caller dialed (the tracking/DNI number). Convirza routes calls from this number through the configured call flow. String of digits.

agent_ring_tostring required

Phone number of the agent receiving SMS replies. String. Must resolve to 10 digits; formatting like parentheses, dashes, or '+1' prefix is accepted.

messagestring required

SMS message body. String. Max length set by carrier (typically 160 chars for single-segment, up to 1600 for concatenated).

contact_idsinteger[]

Array of contact IDs to send to. Either contact_ids or contact_list_ids must be provided (not both). Example [101, 202]. Type: array of integer.

contact_list_idsinteger[]

Array of contact list IDs to send to. Either contact_ids or contact_list_ids must be provided (not both). Example [1, 2, 3]. Type: array of integer.

group_idinteger required

Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.

is_scheduledboolean

Boolean. If true, the broadcast is queued for future delivery; if false, it sends immediately. Default false.

schedule_datetimestring date-time

When to send the broadcast, required when is_scheduled=true. Format 'YYYY-MM-DD HH:mm:ss'.

Response

Broadcast created successfully with bulk_sms_conversations_id

resultstring required

Outcome of the request. String, typically 'success' or 'error'.

errstring required

Error message when result='error'. String. Empty/null on success.

datastring

Response payload. Shape varies by endpoint.