---
title: "Find text broadcasts"
method: GET
path: "/texts/broadcasts"
tags: ["texts"]
---

# Find text broadcasts

`GET /texts/broadcasts`

Searches for all text broadcasts created by user. Can query on label, name, and the current running status of the campaign. Returns a paged list of text broadcasts

## Query parameters

- `name` string
- `label` string
- `running` boolean
- `scheduled` boolean
- `intervalBegin` integer
- `intervalEnd` integer
- `limit` integer
- `offset` integer
- `fields` string

## Response `200`

successful operation

- TextBroadcastPage — ~
  - `items` object[] — A list of returned items
    - `id` integer — A unique id of a broadcast
    - `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. 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 — A time when the given resource was updated, formatted in unix time milliseconds (read only). Example: 1473781817000
    - `fromNumber` string — A phone number in E.164 format (11-digit) or short code. Example: 12132000384, 67076, etc
    - `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[] — ~
      - `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 — A maximum number of texts that CallFire dials at once
    - `labels` string[] — A labels of a broadcast
    - `resumeNextDay` boolean — ~
    - `recipients` TextRecipient[] — Recipients of a text campaign, can be an existing contacts or a new one
      - `phoneNumber` string — Phone number in E.164 format (11-digit) or short code. Example: 12132000384, 67076
      - `fromNumber` string — ~
      - `contactId` integer — An id of existing contact in account
      - `attributes` object — A map of string attributes associated with a recipient
      - `message` string — A text message
      - `media` Media[] — A list of media objects' ids associated with a text message
        - `id` integer — An id of a media file
        - `accountId` integer — ~
        - `name` string — A name of a media file
        - `created` integer — The time when the given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000
        - `lengthInBytes` integer — A size of a media file in bytes
        - `mediaType` string — A MIME type of media file, ex: image/jpeg, image/png, video/mp4, audio/mp3, etc
        - `publicUrl` string — A public URL of a media file
      - `extractedSingleRecipient` boolean — ~
      - `meta` object — ~
    - `message` string — 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
    - `media` Media[] — ~
      - `id` integer — An id of a media file
      - `accountId` integer — ~
      - `name` string — A name of a media file
      - `created` integer — The time when the given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000
      - `lengthInBytes` integer — A size of a media file in bytes
      - `mediaType` string — A MIME type of media file, ex: image/jpeg, image/png, video/mp4, audio/mp3, etc
      - `publicUrl` string — A public URL of a media file
  - `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)