Webex · Schema

TranscriptObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	A unique identifier for the transcript.
siteUrl	string	URL of the Webex site from which the API lists meeting transcripts.
startTime	string	Start time for the meeting transcript in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.
meetingTopic	string	The meeting's topic.
meetingId	string	Unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the transcripts belong.
scheduledMeetingId	string	Unique identifier for scheduled meeting with which the current meeting is associated. Only apples to a meeting instance which is happening or has happened. This is the `id` of the scheduled meeting wi
meetingSeriesId	string	Unique identifier for the parent meeting series to which the recording belongs.
hostUserId	string	Unique identifier for the meeting host.
vttDownloadLink	string	The download link for the transcript vtt file.
txtDownloadLink	string	The download link for the transcript txt file.
status	string	* `available` - Transcript is available. * `deleted` - Transcript has been deleted.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TranscriptObject",
  "title": "TranscriptObject",
  "type": "object",
  "required": [
    "id",
    "siteUrl",
    "startTime",
    "meetingTopic",
    "meetingId",
    "scheduledMeetingId",
    "hostUserId",
    "vttDownloadLink",
    "txtDownloadLink",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "195d64646ad14be2924ea50f541fd91d",
      "description": "A unique identifier for the transcript."
    },
    "siteUrl": {
      "type": "string",
      "example": "example.webex.com",
      "description": "URL of the Webex site from which the API lists meeting transcripts."
    },
    "startTime": {
      "type": "string",
      "example": "2020-06-01T20:30:15.042Z",
      "description": "Start time for the meeting transcript in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
    },
    "meetingTopic": {
      "type": "string",
      "example": "John's Meeting",
      "description": "The meeting's topic."
    },
    "meetingId": {
      "type": "string",
      "example": "0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044",
      "description": "Unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the transcripts belong."
    },
    "scheduledMeetingId": {
      "type": "string",
      "example": "0ed74a1c0551494fb7a04e2881bf50ae_20210401T232500Z",
      "description": "Unique identifier for scheduled meeting with which the current meeting is associated. Only apples to a meeting instance which is happening or has happened. This is the `id` of the scheduled meeting with which the instance is associated."
    },
    "meetingSeriesId": {
      "type": "string",
      "example": "0ed74a1c0551494fb7a04e2881bf50ae",
      "description": "Unique identifier for the parent meeting series to which the recording belongs."
    },
    "hostUserId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83QkFCQkU5OS1CNDNFLTREM0YtOTE0Ny1BMUU5RDQ2QzlDQTA",
      "description": "Unique identifier for the meeting host."
    },
    "vttDownloadLink": {
      "type": "string",
      "example": "http://site-example.webex.com/v1/meetingTranscripts/195d64646ad14be2924ea50f541fd91d/download?format=vtt",
      "description": "The download link for the transcript vtt file."
    },
    "txtDownloadLink": {
      "type": "string",
      "example": "http://site-example.webex.com/v1/meetingTranscripts/195d64646ad14be2924ea50f541fd91d/download?format=txt",
      "description": "The download link for the transcript txt file."
    },
    "status": {
      "type": "string",
      "enum": [
        "available",
        "deleted"
      ],
      "description": " * `available` - Transcript is available.\n * `deleted` - Transcript has been deleted.\n"
    }
  }
}