action callfire_get_call_broadcast {
  label: "Find a specific call broadcast"
  description: "Returns a single CallBroadcast instance for a given call broadcast campaign id"
  provider: callfire
  method: GET
  path: "/calls/broadcasts/{id}"
  encoding: json
  input: {
    type: "object"
    properties: {
      fields: {
        type: "string"
      }
      id: {
        type: "integer"
        format: "int64"
      }
    }
    required: ["id"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Call broadcast can be used to send out a voice message to a group of numbers. It supports IVR scripting, scheduling, retry logic, playing pre-recorded sounds, answering machine detection"
    properties: {
      answeringMachineConfig: {
        type: "string"
        description: "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"
        enum: ["AM_ONLY", "AM_AND_LIVE", "LIVE_WITH_AMD", "LIVE_IMMEDIATE"]
      }
      dialplanXml: {
        type: "string"
        description: "IVR xml is a document which describes the dialplan to setup the IVR broadcast"
      }
      fromNumber: {
        type: "string"
        description: "Phone number in E.164 format (11-digit) or short code for text. Example: 12132000384, 67076"
      }
      id: {
        type: "integer"
        format: "int64"
        description: "A unique id of broadcast (readonly)"
      }
      labels: {
        type: "array"
        description: "Labels of a broadcast"
        items: {
          type: "string"
        }
      }
      lastModified: {
        type: "integer"
        format: "int64"
        description: "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 "
      }
      localTimeRestriction: {
        type: "object"
        description: "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"
        properties: {
          beginHour: {
            type: "integer"
            format: "int32"
            description: "An hour of restriction start"
          }
          beginMinute: {
            type: "integer"
            format: "int32"
            description: "The minutes to start a restriction"
          }
          enabled: {
            type: "boolean"
            description: "A restriction enabled"
          }
          endHour: {
            type: "integer"
            format: "int32"
            description: "An hour of restriction end"
          }
          endMinute: {
            type: "integer"
            format: "int32"
            description: "The minutes of restriction end"
          }
        }
      }
      maxActive: {
        type: "integer"
        format: "int32"
        description: "Sets a maximum number of calls to be dialed by CallFire at once"
      }
      maxActiveTransfers: {
        type: "integer"
        format: "int32"
        description: "A maximum number of active transfers"
      }
      name: {
        type: "string"
        description: "A name of a broadcast"
      }
      recipients: {
        type: "array"
        description: "Recipients of a call broadcast, can be either existing contacts or a new ones"
        items: {
          type: "object"
          description: "A recipient of a campaign action. It can be a phone number, contact, or contact list with attributes added to an action, one of these values should be set"
          properties: {
            attributes: {
              type: "object"
              description: "Map of user-defined string attributes associated with recipient"
            }
            contactId: {
              type: "integer"
              format: "int64"
              description: "An id of existing contact used as recipient"
            }
            fromNumber: {
              type: "string"
              description: "~"
            }
            phoneNumber: {
              type: "string"
              description: "A recipient's phone number in E.164 format (11-digit) or short code. Example: 12132000384, 67076"
            }
          }
        }
      }
      resumeNextDay: {
        type: "boolean"
        description: "If true resumes the unfinished campaign to the next day"
      }
      retryConfig: {
        type: "object"
        description: "Retry configuration will help you to resend a call or text if it was not delivered first time"
        properties: {
          maxAttempts: {
            type: "integer"
            format: "int32"
            description: "Maximum number of retry attempts. Default value: 1"
          }
          minutesBetweenAttempts: {
            type: "integer"
            format: "int32"
            description: "A number of minutes between retry attempts. Default value: 60"
          }
          retryPhoneTypes: {
            type: "array"
            description: "A list of phone number types to retry. Available values: FIRST_NUMBER, HOME_PHONE, WORK_PHONE, MOBILE_PHONE"
            items: {
              type: "string"
            }
          }
          retryResults: {
            type: "array"
            description: "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)"
            items: {
              type: "string"
            }
          }
        }
      }
      schedules: {
        type: "array"
        description: "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"
        items: {
          type: "object"
          description: "A campaign schedule"
          properties: {
            campaignId: {
              type: "integer"
              format: "int64"
              description: "~"
            }
            daysOfWeek: {
              type: "array"
              description: "~"
              items: {
                type: "string"
              }
            }
            id: {
              type: "integer"
              format: "int64"
              description: "~"
            }
            startDate: {
              type: "object"
              description: "Represents a date object (without time part)"
              properties: {
                day: {
                  type: "integer"
                  format: "int32"
                  description: "A day of the month. Available values: 1-31"
                }
                month: {
                  type: "integer"
                  format: "int32"
                  description: "A month of the year. Available values: 1-12"
                }
                year: {
                  type: "integer"
                  format: "int32"
                  description: "A year. Example: 2020"
                }
              }
            }
            startTimeOfDay: {
              type: "object"
              description: "Represents a time part of a given date"
              properties: {
                hour: {
                  type: "integer"
                  format: "int32"
                  description: "An hour of the day. Available values: 0-23"
                }
                minute: {
                  type: "integer"
                  format: "int32"
                  description: "The minutes. Available values: 0-59"
                }
                nano: {
                  type: "integer"
                  format: "int32"
                  description: "~"
                }
                second: {
                  type: "integer"
                  format: "int32"
                  description: "The seconds.  Available values: 0-59"
                }
              }
            }
            stopDate: {
              type: "object"
              additionalProperties: true
            }
            stopTimeOfDay: {
              type: "object"
              additionalProperties: true
            }
            timeZone: {
              type: "string"
              description: "~"
            }
          }
        }
      }
      sounds: {
        type: "object"
        description: "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"
        properties: {
          dncDigit: {
            type: "string"
            description: "Digit pressed to place contact in DNC list"
          }
          dncSoundId: {
            type: "integer"
            format: "int64"
            description: "An id of sound file to play when recipient decided to opt out and pressed DNC digit"
          }
          dncSoundText: {
            type: "string"
            description: "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: {
            type: "string"
            description: "The voice to be used (MALE1, FEMALE1, FEMALE2, SPANISH1, FRENCHCANADIAN1)"
            enum: ["MALE1", "FEMALE1", "FEMALE2", "SPANISH1", "FRENCHCANADIAN1"]
          }
          liveSoundId: {
            type: "integer"
            format: "int64"
            description: "An id of sound file to play if phone is answered"
          }
          liveSoundText: {
            type: "string"
            description: "Text to be used to turned into a sound. This text will be played when the phone is answered"
          }
          liveSoundTextVoice: {
            type: "string"
            description: "The voice to be used (MALE1, FEMALE1, FEMALE2, SPANISH1, FRENCHCANADIAN1) for a live sound"
            enum: ["MALE1", "FEMALE1", "FEMALE2", "SPANISH1", "FRENCHCANADIAN1"]
          }
          machineSoundId: {
            type: "integer"
            format: "int64"
            description: "An id of a sound file to play if answering machine is detected"
          }
          machineSoundText: {
            type: "string"
            description: "Text to be turned into a sound. This text will be played when answering machine is detected"
          }
          machineSoundTextVoice: {
            type: "string"
            description: "The voice to be used (MALE1, FEMALE1 , FEMALE2, SPANISH1, FRENCHCANADIAN1) for a machine sound"
            enum: ["MALE1", "FEMALE1", "FEMALE2", "SPANISH1", "FRENCHCANADIAN1"]
          }
          transferDigit: {
            type: "string"
            description: "Digit pressed to initiate a transfer"
          }
          transferNumber: {
            type: "string"
            description: "Phone number in E.164 format (11-digit) to transfer call to.  Example: 12132000384, 67076"
          }
          transferSoundId: {
            type: "integer"
            format: "int64"
            description: "An id of a file to play if call is transferred"
          }
          transferSoundText: {
            type: "string"
            description: "Text to be turned into a sound. This text will be played when the transfer digit is played"
          }
          transferSoundTextVoice: {
            type: "string"
            description: "The voice to be used (MALE1, FEMALE1, FEMALE2, SPANISH1, FRENCHCANADIAN1) for a sound transfer"
            enum: ["MALE1", "FEMALE1", "FEMALE2", "SPANISH1", "FRENCHCANADIAN1"]
          }
        }
      }
      status: {
        type: "string"
        description: "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"
        enum: ["TEST", "SETUP", "START_PENDING", "RUNNING", "SCHEDULED", "STOPPED", "SUSPENDED", "FINISHED", "ARCHIVED", "VALIDATING_START", "VALIDATING_EMAIL", "BLOCKED_SUSPICIOUS", "DECLINED", "APPROVED"]
      }
    }
  }
}