Bandwidth · JSON Structure

Voice Transcription Structure

Transcription schema from Bandwidth voice API

Type: object Properties: 4
CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

Transcription is a JSON Structure definition published by Bandwidth, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id status completedTime url

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bandwidth/refs/heads/main/json-structure/voice-transcription-structure.json",
  "name": "Transcription",
  "description": "Transcription schema from Bandwidth voice API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for the transcription"
    },
    "status": {
      "type": "string",
      "enum": [
        "none",
        "available",
        "error"
      ],
      "description": "The status of the transcription"
    },
    "completedTime": {
      "type": "datetime",
      "description": "The time the transcription was completed"
    },
    "url": {
      "type": "uri",
      "description": "The URL of the transcription result"
    }
  }
}