---
title: "Broadcast Information"
method: GET
path: "/v2/broadcasts/{id}"
tags: ["Broadcasts"]
---

# Broadcast Information

`GET /v2/broadcasts/{id}`

This endpoint allows you to read the information of a certain Broadcast that was previously created.

## Path parameters

- `id` integer, required

## Response `200`

Successfully retrieved the broadcast

- BroadcastCreateResponse
  - `meta` MetadataDTO
    - `timestamp` integer, required — Transaction's date in timestamp
    - `transactionId` string, required — Id for the current transaction (Endpoint's call)
    - `explain` string — Explain string in case of failure
  - `data` BroadcastResponse — list of broadcasts
    - `id` integer — broadcast id
    - `beginDate` string, date-time — broadcast begin date in UTC
    - `endDate` string, date-time — broadcast end date in UTC
    - `deliveryMethod` 'SMS' | 'EMAIL' | 'RCS' | 'WHATSAPP' | 'SMS_MO' — delivery method or digital channel to broadcast messages - SMS/EMAIL/RCS/WHATSAPP -
    - `campaignName` string — broadcast name
    - `createdBy` string — broadcast creator username
    - `operator` string — broadcast operator username
    - `description` string — broadcast description
    - `listId` integer — list ID used in broadcast
    - `listSize` integer — list size used in broadcast
    - `listField` string — field from list used in broadcast
    - `filters` string — filters - in URL encoded format - applied to the list used in the broadcast
    - `filterName` string — filter name
    - `segmentId` string — segment id
    - `message` string — broadcast description
    - `origin` string — broadcast origin: code in sms, from in email
    - `broadcastDate` string, date-time — broadcast date in UTC
    - `broadcastStatus` 'DONE' | 'PENDING' | 'SCHEDULED' | 'SENDING' | 'SUSPENDED' | 'PAUSED' | 'DONE_WITH_FLAWS' | 'FATAL_ERROR' — broadcast status
    - `createdAt` string, date-time — broadcast creation date in UTC
    - `scheduleWithoutDate` boolean — flag to trigger now or schedule broadcast
    - `throttle` integer — throttle rate
    - `callbacks` string[] — callbacks list
    - `notSentCounter` integer — number of messages that have not been sent
    - `messagesSentCounter` integer — number of messages that have been sent
    - `smsField` string — list sms field - user additional field to be used in BigQuery reports
    - `emailField` string — list email field - user additional field to be used in BigQuery reports
    - `clientId` string — client Id field - user additional field to be used in BigQuery reports
    - `fallback` Fallback — Configuration to trigger the fallback mechanism
      - `channels` object[] — Map list to add configuration per channel
    - `multimediaFileName` string — Multimedia File Name
    - `report` Report — Information about reports from missandei to differents broadcasts
      - `sent` string — the message was sent
      - `delivered` string — the message was delivered
      - `unique_clicked` string — when the customer clicked at least once
      - `clicked` string — When the customer clicks
      - `failed` string — when the message failed
    - `requestDR` boolean — ONLY SMS: request DR flag
    - `subject` string — ONLY EMAIL: email broadcast subject. required in email broadcast
    - `draftId` string — ONLY EMAIL: email broadcast draft Id
    - `attachmentName` string — attachment name
    - `rcsConfig` RcsConfig — ONLY RCS: particular RCS broadcast information
      - `rcsMessage` object — RCS message payload. changes according to the type of RCS: text or standalonecard
      - `rcsMessageType` string — RCS message type: text or standalonecard
      - `rcsSuggestions` object[] — list with suggestions map
    - `whatsappConfig` WhatsAppConfig — ONLY WHATSAPP: particular WHATSAPP broadcast information
      - `whatsappTemplateName` string
      - `whatsappTemplateLanguage` string
      - `whatsappTemplateHeader` object
      - `whatsappTemplateButtons` TemplateButtons[]
        - `type` 'cta' | 'quick-reply' | 'flow', required — Button type
        - `values` ButtonValue[]
          - `index` integer, required — Button index position
          - `value` string — Button value/text. Required for regular buttons, optional for flow buttons
      - `whatsappTemplateId` string
    - `caption` string
    - `type` string

## Other responses

- `400` — bad request
- `401` — unauthorized: malformed jwt
- `404` — broadcast not found
- `410` — gone: expired jwt
- `500` — internal server error

---

[API](https://skmtc.dev/messangi/apis/raven.md) · [All operations](https://skmtc.dev/messangi/apis/raven/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/messangi/raven/revisions/c87f398fa338/schema)
