Sign in

v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
texts

Create a text broadcast

Creates a text broadcast campaign using the Text Broadcast API. Send a TextBroadcast object in the message body to detail a text broadcast campaign. A campaign can be created without contacts and with bare minimum configuration, but contacts have to be added further on to use the campaign. It supports scheduling, retry logic, pattern-based messages.

post/texts/broadcasts

Query parameters

startboolean

If true then starts the campaign immediately (not required).

strictValidationboolean

Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation

Request body

idinteger

A unique id of a broadcast

namestring

A name of a broadcast

status'TEST' | 'SETUP' | 'START_PENDING' | 'RUNNING' | 'SCHEDULED' | 'STOPPED' | 'SUSPENDED' | 'FINISHED' | 'ARCHIVED' | 'VALIDATING_START' | 'VALIDATING_EMAIL' | 'BLOCKED_SUSPICIOUS' | 'DECLINED' | 'APPROVED' | 'PAUSED' | 'CANCELED'

A status of a broadcast. SETUP - campaign isn't configured yet; START_PENDING - waiting for contact batch population; RUNNING - campaign is running; STOPPED - campaign is stopped; FINISHED - campaign is finished; ARCHIVED - campaign was archived

statusReasonstring

~

lastModifiedinteger

A time when the given resource was updated, formatted in unix time milliseconds (read only). Example: 1473781817000

fromNumberstring

A phone number in E.164 format (11-digit) or short code. Example: 12132000384, 67076, etc

maxActiveinteger

A maximum number of texts that CallFire dials at once

labelsstring[]

A labels of a broadcast

resumeNextDayboolean

~

messagestring

A text message

bigMessageStrategy'SEND_MULTIPLE' | 'DO_NOT_SEND' | 'TRIM' | 'MMS' | 'RCS'

If message length exceeds 160 characters, multiple messages will be sent, SEND_MULTIPLE strategy is chosen by default. Available values: SEND_MULTIPLE - send text as multiple messages, DO_NOT_SEND - do not send text if it exceeds 160 characters, TRIM - trims text message to 160 characters

Response

successful operation

idinteger

An id of a resource