Bandwidth · Schema

Recording

Recording schema from Bandwidth voice API

CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

Properties

Name Type Description
recordingId string The unique identifier for the recording
accountId string The Bandwidth account ID
callId string The call ID associated with this recording
applicationId string The application ID
duration string The duration of the recording in ISO 8601 format
channels integer The number of audio channels in the recording
startTime string The time the recording started
endTime string The time the recording ended
fileFormat string The audio format of the recording
status string The status of the recording
mediaUrl string The URL to download the recording media
transcription object
View JSON Schema on GitHub

JSON Schema

voice-recording-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bandwidth/refs/heads/main/json-schema/voice-recording-schema.json",
  "title": "Recording",
  "description": "Recording schema from Bandwidth voice API",
  "type": "object",
  "properties": {
    "recordingId": {
      "type": "string",
      "description": "The unique identifier for the recording"
    },
    "accountId": {
      "type": "string",
      "description": "The Bandwidth account ID"
    },
    "callId": {
      "type": "string",
      "description": "The call ID associated with this recording"
    },
    "applicationId": {
      "type": "string",
      "description": "The application ID"
    },
    "duration": {
      "type": "string",
      "description": "The duration of the recording in ISO 8601 format"
    },
    "channels": {
      "type": "integer",
      "description": "The number of audio channels in the recording"
    },
    "startTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time the recording started"
    },
    "endTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time the recording ended"
    },
    "fileFormat": {
      "type": "string",
      "enum": [
        "wav",
        "mp3"
      ],
      "description": "The audio format of the recording"
    },
    "status": {
      "type": "string",
      "enum": [
        "complete",
        "partial",
        "error"
      ],
      "description": "The status of the recording"
    },
    "mediaUrl": {
      "type": "string",
      "format": "uri",
      "description": "The URL to download the recording media"
    },
    "transcription": {
      "$ref": "#/components/schemas/Transcription"
    }
  }
}