messagebird · Schema

Recording

Properties

Name Type Description
id string The unique identifier of the recording.
format string The format of the recording file.
legId string The unique identifier of the leg this recording belongs to.
status string The status of the recording.
duration integer The duration of the recording in seconds.
createdAt string The date and time when the recording was created.
updatedAt string The date and time when the recording was last updated.
View JSON Schema on GitHub

JSON Schema

messagebird-recording-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Recording",
  "title": "Recording",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the recording."
    },
    "format": {
      "type": "string",
      "description": "The format of the recording file.",
      "enum": [
        "wav"
      ]
    },
    "legId": {
      "type": "string",
      "description": "The unique identifier of the leg this recording belongs to."
    },
    "status": {
      "type": "string",
      "description": "The status of the recording.",
      "enum": [
        "initialised",
        "recording",
        "done",
        "failed"
      ]
    },
    "duration": {
      "type": "integer",
      "description": "The duration of the recording in seconds."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the recording was created."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the recording was last updated."
    }
  }
}