Sign in

v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
calls

Find a specific call broadcast

Returns a single CallBroadcast instance for a given call broadcast campaign id

get/calls/broadcasts/{id}

Path parameters

idinteger required

An id of a CallBroadcast

Query parameters

fieldsstring

Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page.

Response

successful operation

idinteger

A unique id of broadcast (readonly)

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 (read only). 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

The time when a given resource was updated, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT

fromNumberstring

Phone number in E.164 format (11-digit) or short code for text. Example: 12132000384, 67076

maxActiveinteger

Sets a maximum number of calls to be dialed by CallFire at once

labelsstring[]

Labels of a broadcast

resumeNextDayboolean

If true resumes the unfinished campaign to the next day

dialplanXmlstring

IVR xml is a document which describes the dialplan to setup the IVR broadcast

answeringMachineConfig'AM_ONLY' | 'AM_AND_LIVE' | 'LIVE_WITH_AMD' | 'LIVE_IMMEDIATE'

Specifies which action should be taken if answering machine was detected, default value: AM_AND_LIVE. Available values: AM_ONLY - run AMD (Answering Machine Detection), hang up if LA (Live Answer); AM_AND_LIVE - run AMD, play separate live vs. machine sound; LIVE_WITH_AMD, run AMD, hang up if machine answers; LIVE_IMMEDIATE - no AMD, play live sound immediately

maxActiveTransfersinteger

A maximum number of active transfers