action callfire_get_call {
  label: "Find a specific call"
  description: "Returns a single Call instance for a given call id."
  provider: callfire
  method: GET
  path: "/calls/{id}"
  encoding: json
  input: {
    type: "object"
    properties: {
      fields: {
        type: "string"
      }
      id: {
        type: "integer"
        format: "int64"
      }
    }
    required: ["id"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Represents a call action sent or received by CallFire platform"
    properties: {
      agentCall: {
        type: "boolean"
        description: "An internal call to an agent"
      }
      attributes: {
        type: "object"
        description: "Map of user-defined string attributes associated with an action"
      }
      batchId: {
        type: "integer"
        format: "int64"
        description: "An id of contact batch associated with an action"
      }
      campaignId: {
        type: "integer"
        format: "int64"
        description: "An id of broadcast associated with an action if call is sent as part of call broadcast"
      }
      contact: {
        type: "object"
        description: "Represents a contact in CallFire platform. Contains info about the people you want to contact. It allows you to store a user-defined properties for each contact"
        properties: {
          deleted: {
            type: "boolean"
            description: "A deleted contact, deleted contacts are hidden from search results"
          }
          externalId: {
            type: "string"
            description: "An external id of a contact for syncing with external sources"
          }
          externalSystem: {
            type: "string"
            description: "External system that external id refers to"
          }
          extraPhone1: {
            type: "string"
            description: "Phone number in E.164 format (11-digit). Example: 12132000384"
          }
          extraPhone2: {
            type: "string"
            description: "Phone number in E.164 format (11-digit). Example: 12132000384"
          }
          extraPhone3: {
            type: "string"
            description: "Phone number in E.164 format (11-digit). Example: 12132000384"
          }
          firstName: {
            type: "string"
            description: "A first name of a contact"
          }
          homePhone: {
            type: "string"
            description: "Phone number in E.164 format (11-digit). Example: 12132000384"
          }
          id: {
            type: "integer"
            format: "int64"
            description: "An id of a contact"
          }
          lastName: {
            type: "string"
            description: "A last name of a contact"
          }
          mobilePhone: {
            type: "string"
            description: "Phone number in E.164 format (11-digit). Example: 12132000384"
          }
          properties: {
            type: "object"
            description: "Map of user-defined string properties for contact"
          }
          workPhone: {
            type: "string"
            description: "Phone number in E.164 format (11-digit). Example: 12132000384"
          }
          zipcode: {
            type: "string"
            description: "A Zip code of a contact"
          }
        }
      }
      created: {
        type: "integer"
        format: "int64"
        description: "The time when the given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT "
      }
      finalCallResult: {
        type: "string"
        description: "Result of a call (LA, AM, BUSY, DNC, XFER, NO_ANS, XFER_LEG, INTERNAL_ERROR, CARRIER_ERROR, CARRIER_TEMP_ERROR, UNDIALED, SD, POSTPONED, ABANDONED, SKIPPED). See [call states and results](https://developers.callfire.com/results-responses-errors.html)"
        enum: ["LA", "AM", "BUSY", "DNC", "XFER", "NO_ANS", "XFER_LEG", "INTERNAL_ERROR", "CARRIER_ERROR", "CARRIER_TEMP_ERROR", "UNDIALED", "SD", "POSTPONED", "ABANDONED", "SKIPPED"]
      }
      fromNumber: {
        type: "string"
        description: "A sender's phone number in E.164 (11-digit) format"
      }
      id: {
        type: "integer"
        format: "int64"
        description: "An id of  an action"
      }
      inbound: {
        type: "boolean"
        description: "Is action inbound"
      }
      labels: {
        type: "array"
        description: "Labels associated with action or broadcast for this action"
        items: {
          type: "string"
        }
      }
      modified: {
        type: "integer"
        format: "int64"
        description: "The time when the given resource was modified, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT "
      }
      notes: {
        type: "array"
        description: "Notes of call added by an agent"
        items: {
          type: "object"
          description: "Represents a note which can be added to a call"
          properties: {
            created: {
              type: "integer"
              format: "int64"
              description: "The time when the given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000"
            }
            text: {
              type: "string"
              description: "A text of a note"
            }
          }
        }
      }
      records: {
        type: "array"
        description: "List of call records, each record contains call details like originate time, duration, cost, notes made by agents. A single contact may have a multiple phone numbers. In this case if given call was sent as a part of broadcast with configured retry logic then each call record will contain details about attempted phone number"
        items: {
          type: "object"
          description: "Represents a call sent to a contact's number"
          properties: {
            answerTime: {
              type: "integer"
              format: "int64"
              description: "Timestamp when call was answered, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"
            }
            billedAmount: {
              type: "number"
              format: "float"
              description: "A cost of the call"
            }
            callerName: {
              type: "string"
              description: "~"
            }
            duration: {
              type: "integer"
              format: "int64"
              description: "Duration of the call in seconds"
            }
            finishTime: {
              type: "integer"
              format: "int64"
              description: "Timestamp when call was finished, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"
            }
            id: {
              type: "integer"
              format: "int64"
              description: "An id of a call record"
            }
            labels: {
              type: "array"
              description: "Labels associated with a call action"
              items: {
                type: "string"
              }
            }
            notes: {
              type: "array"
              description: "Notes of call added by agent"
              items: {
                type: "object"
                additionalProperties: true
              }
            }
            originateTime: {
              type: "integer"
              format: "int64"
              description: "A date and time (timestamp) when call was originated by CallFire platform and went to downstream provider, formatted in unix time milliseconds (read only). Example: 1473781817000 "
            }
            questionResponses: {
              type: "array"
              description: "Notes of call added by an agent"
              items: {
                type: "object"
                description: "Object represents the question and client's answer, used in cloud call center / IVR campaign"
                properties: {
                  question: {
                    type: "string"
                    description: "A text of a question"
                  }
                  response: {
                    type: "string"
                    description: "Client's answer"
                  }
                }
              }
            }
            recordings: {
              type: "array"
              description: "A list of voice recordings of the call"
              items: {
                type: "object"
                description: "Represents a recording of a voice call"
                properties: {
                  callId: {
                    type: "integer"
                    format: "int64"
                    description: "An id of a call action"
                  }
                  campaignId: {
                    type: "integer"
                    format: "int64"
                    description: "Contains broadcast id if call was sent as a part of voice broadcast"
                  }
                  created: {
                    type: "integer"
                    format: "int64"
                    description: "The time when the given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"
                  }
                  hash: {
                    type: "string"
                    description: "A unique string hash identifier of a recording"
                  }
                  id: {
                    type: "integer"
                    format: "int64"
                    description: "An id of a call recording"
                  }
                  lengthInBytes: {
                    type: "integer"
                    format: "int64"
                    description: "A size of a recording file in bytes"
                  }
                  lengthInSeconds: {
                    type: "integer"
                    format: "int32"
                    description: "Duration of a recording in seconds"
                  }
                  mp3Url: {
                    type: "string"
                    description: "A public URL of a call recording"
                  }
                  name: {
                    type: "string"
                    description: "A name of a recording"
                  }
                  state: {
                    type: "string"
                    description: "Current state of a recording, available values: RECORDING - recording is in progress, READY - recording is ready, ERROR - error has occurred and recording can be broken"
                    enum: ["RECORDING", "READY", "ERROR"]
                  }
                }
              }
            }
            result: {
              type: "string"
              description: "~"
              enum: ["LA", "AM", "BUSY", "DNC", "XFER", "NO_ANS", "XFER_LEG", "INTERNAL_ERROR", "CARRIER_ERROR", "CARRIER_TEMP_ERROR", "UNDIALED", "SD", "POSTPONED", "ABANDONED", "SKIPPED"]
            }
            switchId: {
              type: "string"
              description: "~"
            }
            toNumber: {
              type: "string"
              description: "A phone number to which a call was addressed. Phone number in E.164 format (11-digit). Example: 12132000384"
            }
          }
        }
      }
      state: {
        type: "string"
        description: "State of an action (READY, SELECTED, CALLBACK, DISABLED, FINISHED, DNC, DUP, INVALID, TIMEOUT, PERIOD_LIMIT). See [call states and results](https://developers.callfire.com/results-responses-errors.html)"
        enum: ["READY", "SELECTED", "CALLBACK", "FINISHED", "DISABLED", "SKIPPED", "DNC", "DUP", "INVALID", "TIMEOUT", "PERIOD_LIMIT", "RESTRICTED_NUMBER"]
      }
      toNumber: {
        type: "string"
        description: "A recipient's phone number in E.164 (11-digit) format"
      }
    }
  }
}