--- title: "Find call broadcasts" method: GET path: "/calls/broadcasts" tags: ["calls"] --- # Find call broadcasts `GET /calls/broadcasts` Searches for all voice broadcasts created by user. Can query on label, name, and the current running status of the campaign. Returns a paged list of voice broadcasts ## Query parameters - `fields` string - `limit` integer - `offset` integer - `label` string - `name` string - `running` boolean - `scheduled` boolean - `intervalBegin` integer - `intervalEnd` integer ## Response `200` successful operation - CallBroadcastPage — ~ - `items` object[] — A list of returned items - `id` integer — A unique id of broadcast (readonly) - `name` string — 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 - `statusReason` string — ~ - `lastModified` integer — 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 - `fromNumber` string — Phone number in E.164 format (11-digit) or short code for text. Example: 12132000384, 67076 - `localTimeRestriction` LocalTimeRestriction — Represents a range of time during which CallFire will send a call or text to recipients. Timeframe uses the local timezone of recipient's number - `enabled` boolean — A restriction enabled - `beginHour` integer — An hour of restriction start - `beginMinute` integer — The minutes to start a restriction - `endHour` integer — An hour of restriction end - `endMinute` integer — The minutes of restriction end - `schedules` Schedule[] — A list of schedule objects which specifies a range of time when broadcast should be started and stopped. Supports the scheduling per day of week - `startTimeOfDay` LocalTime — Represents a time part of a given date - `hour` integer — An hour of the day. Available values: 0-23 - `minute` integer — The minutes. Available values: 0-59 - `second` integer — The seconds. Available values: 0-59 - `nano` integer — ~ - `stopTimeOfDay` LocalTime — Represents a time part of a given date - `hour` integer — An hour of the day. Available values: 0-23 - `minute` integer — The minutes. Available values: 0-59 - `second` integer — The seconds. Available values: 0-59 - `nano` integer — ~ - `daysOfWeek` string[] — ~ - `timeZone` string — ~ - `id` integer — ~ - `campaignId` integer — ~ - `startDate` LocalDate — Represents a date object (without time part) - `year` integer — A year. Example: 2020 - `month` integer — A month of the year. Available values: 1-12 - `day` integer — A day of the month. Available values: 1-31 - `stopDate` LocalDate — Represents a date object (without time part) - `year` integer — A year. Example: 2020 - `month` integer — A month of the year. Available values: 1-12 - `day` integer — A day of the month. Available values: 1-31 - `maxActive` integer — Sets a maximum number of calls to be dialed by CallFire at once - `labels` string[] — Labels of a broadcast - `resumeNextDay` boolean — If true resumes the unfinished campaign to the next day - `retryConfig` RetryConfig — Retry configuration will help you to resend a call or text if it was not delivered first time - `maxAttempts` integer — Maximum number of retry attempts. Default value: 1 - `minutesBetweenAttempts` integer — A number of minutes between retry attempts. Default value: 60 - `retryResults` string[] — List of result states when a call/text should be addressed to this contact again. Supports any combination of result statuses. Available values: LA, BUSY, AM, NO_ANS, SENT, RECEIVED, etc. See [call/text states and results](https://developers.callfire.com/results-responses-errors.html) - `retryPhoneTypes` string[] — A list of phone number types to retry. Available values: FIRST_NUMBER, HOME_PHONE, WORK_PHONE, MOBILE_PHONE - `recipients` Recipient[] — Recipients of a call broadcast, can be either existing contacts or a new ones - `phoneNumber` string — A recipient's phone number in E.164 format (11-digit) or short code. Example: 12132000384, 67076 - `fromNumber` string — ~ - `contactId` integer — An id of existing contact used as recipient - `attributes` object — Map of user-defined string attributes associated with recipient - `dialplanXml` string — IVR xml is a document which describes the dialplan to setup the IVR broadcast - `sounds` CallBroadcastSounds — A set of sounds assigned to a voice broadcast to play according to an answering machine configuration. You can add the existing sounds from the account's sound library or to provide a text which will be converted into a speech. There are four sound options available for a Voice Broadcast campaign - `liveSoundText` string — Text to be used to turned into a sound. This text will be played when the phone is answered - `liveSoundTextVoice` 'MALE1' | 'FEMALE1' | 'FEMALE2' | 'SPANISH1' | 'FRENCHCANADIAN1' — The voice to be used (MALE1, FEMALE1, FEMALE2, SPANISH1, FRENCHCANADIAN1) for a live sound - `liveSoundId` integer — An id of sound file to play if phone is answered - `machineSoundText` string — Text to be turned into a sound. This text will be played when answering machine is detected - `machineSoundTextVoice` 'MALE1' | 'FEMALE1' | 'FEMALE2' | 'SPANISH1' | 'FRENCHCANADIAN1' — The voice to be used (MALE1, FEMALE1 , FEMALE2, SPANISH1, FRENCHCANADIAN1) for a machine sound - `machineSoundId` integer — An id of a sound file to play if answering machine is detected - `transferSoundText` string — Text to be turned into a sound. This text will be played when the transfer digit is played - `transferSoundTextVoice` 'MALE1' | 'FEMALE1' | 'FEMALE2' | 'SPANISH1' | 'FRENCHCANADIAN1' — The voice to be used (MALE1, FEMALE1, FEMALE2, SPANISH1, FRENCHCANADIAN1) for a sound transfer - `transferSoundId` integer — An id of a file to play if call is transferred - `transferDigit` string — Digit pressed to initiate a transfer - `transferNumber` string — Phone number in E.164 format (11-digit) to transfer call to. Example: 12132000384, 67076 - `dncSoundText` string — Text to be turned into sound, plays to notify that Do Not Call digit has been pressed and inform your contact of their placement on the Do Not Call list - `dncSoundTextVoice` 'MALE1' | 'FEMALE1' | 'FEMALE2' | 'SPANISH1' | 'FRENCHCANADIAN1' — The voice to be used (MALE1, FEMALE1, FEMALE2, SPANISH1, FRENCHCANADIAN1) - `dncSoundId` integer — An id of sound file to play when recipient decided to opt out and pressed DNC digit - `dncDigit` string — Digit pressed to place contact in DNC list - `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 - `maxActiveTransfers` integer — A maximum number of active transfers - `limit` integer — A maximum number of returned items. If items.size() < limit assume no more items - `offset` integer — An offset from a start of paging source - `totalCount` integer — Total count of available results. -1 if unknown ## Other responses - `400` — Bad request - `401` — Unauthorized - `403` — Forbidden - `404` — Not found - `500` — Internal Server Error --- [API](https://skmtc.net/callfire/apis/callfire-api-documentation.md) · [All operations](https://skmtc.net/callfire/apis/callfire-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/callfire/callfire-api-documentation/versions/9f6fb501bc03/schema)