action callfire_get_text_broadcast {
  label: "Find a specific text broadcast"
  description: "Returns a single TextBroadcast instance for a given text broadcast id"
  provider: callfire
  method: GET
  path: "/texts/broadcasts/{id}"
  encoding: json
  input: {
    type: "object"
    properties: {
      fields: {
        type: "string"
      }
      id: {
        type: "integer"
        format: "int64"
      }
    }
    required: ["id"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "A text campaign allows you to send a text message to a number of recipients. It supports scheduling, retry logic and pattern-based messages"
    properties: {
      bigMessageStrategy: {
        type: "string"
        description: "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"
        enum: ["SEND_MULTIPLE", "DO_NOT_SEND", "TRIM", "MMS"]
      }
      fromNumber: {
        type: "string"
        description: "A phone number in E.164 format (11-digit) or short code. Example: 12132000384, 67076, etc"
      }
      id: {
        type: "integer"
        format: "int64"
        description: "A unique id of a broadcast"
      }
      labels: {
        type: "array"
        description: "A labels of a broadcast"
        items: {
          type: "string"
        }
      }
      lastModified: {
        type: "integer"
        format: "int64"
        description: "A time when the given resource was updated, formatted in unix time milliseconds (read only). Example: 1473781817000"
      }
      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: "A maximum number of texts that CallFire dials at once"
      }
      media: {
        type: "array"
        description: "~"
        items: {
          type: "object"
          description: "Represents a media file which can be added to a text message"
          properties: {
            accountId: {
              type: "integer"
              format: "int64"
              description: "~"
            }
            created: {
              type: "integer"
              format: "int64"
              description: "The time when the given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000 "
            }
            id: {
              type: "integer"
              format: "int64"
              description: "An id of a media file"
            }
            lengthInBytes: {
              type: "integer"
              format: "int64"
              description: "A size of a media file in bytes"
            }
            mediaType: {
              type: "string"
              description: "A MIME type of media file, ex: image/jpeg, image/png, video/mp4, audio/mp3, etc"
            }
            name: {
              type: "string"
              description: "A name of a media file"
            }
            publicUrl: {
              type: "string"
              description: "A public URL of a media file"
            }
          }
        }
      }
      message: {
        type: "string"
        description: "A text message"
      }
      name: {
        type: "string"
        description: "A name of a broadcast"
      }
      recipients: {
        type: "array"
        description: "Recipients of a text campaign, can be an existing contacts or a new one"
        items: {
          type: "object"
          description: "A recipient of a text message. You should provide either phone number or contact id of existing contact"
          properties: {
            attributes: {
              type: "object"
              description: "A map of string attributes associated with a recipient"
            }
            contactId: {
              type: "integer"
              format: "int64"
              description: "An id of existing contact in account"
            }
            fromNumber: {
              type: "string"
              description: "~"
            }
            media: {
              type: "array"
              description: "A list of media objects' ids associated with a text message"
              items: {
                type: "object"
                additionalProperties: true
              }
            }
            message: {
              type: "string"
              description: "A text message"
            }
            phoneNumber: {
              type: "string"
              description: "Phone number in E.164 format (11-digit) or short code. Example: 12132000384, 67076"
            }
          }
        }
      }
      resumeNextDay: {
        type: "boolean"
        description: "~"
      }
      schedules: {
        type: "array"
        description: "~"
        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: "~"
            }
          }
        }
      }
      status: {
        type: "string"
        description: "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"
        enum: ["TEST", "SETUP", "START_PENDING", "RUNNING", "SCHEDULED", "STOPPED", "SUSPENDED", "FINISHED", "ARCHIVED", "VALIDATING_START", "VALIDATING_EMAIL", "BLOCKED_SUSPICIOUS", "DECLINED", "APPROVED"]
      }
    }
  }
}