wxc_sdk.meetings.transcripts package

Meeting transcripts API

class wxc_sdk.meetings.transcripts.MeetingTranscriptsApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Not supported for Webex for Government (FedRAMP) A meeting transcript is the automatic transcription of a meeting’s recordings by our industry-leading speech-to-text engine to capture of what was discussed and decided during the meeting, in text form. A transcript snippet is a short text snippet from a meeting transcript which was spoken by a particular participant in the meeting. A meeting transcript consists of many snippets. This API manages meeting transcripts and snippets. You can use the Transcript API to list meeting transcripts, list, get and update transcript snippets. Transcripts may be retrieved via download link defined by vttDownloadLink or txtDownloadlink in the response body. Refer to the Meetings API Scopes section of Meetings Overview for scopes required for each API. NOTE:

list(meeting_id: str | None = None, host_email: str | None = None, site_url: str | None = None, from_: str | None = None, to_: str | None = None, **params) → Generator[Transcript, None, None][source]

Lists available transcripts of an ended meeting instance. Use this operation to list transcripts of an ended meeting instance when they are ready. Please note that only meeting instances in state ended are supported for meetingId. Meeting series, scheduled meetings and in-progress meeting instances are not supported.

Parameters:

  • meeting_id (str) – Unique identifier for the meeting instance to which the transcript belongs. Please note that currently the meeting ID of a scheduled personal room meeting is not supported for this API. If meetingId is not specified, the operation returns an array of transcripts for all meetings of the current user.

  • host_email (str) – Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API will return details for a meeting that is hosted by that user. If meetingId is not specified, it can not support hostEmail.

  • site_url (str) – URL of the Webex site from which the API lists transcripts. If not specified, the API lists transcripts from user’s preferred site. All available Webex sites and the preferred site of the user can be retrieved by the Get Site List API.

  • from (str) – Starting date and time (inclusive) for transcripts to return, in any ISO 8601 compliant format. from cannot be after to.

  • to (str) – Ending date and time (exclusive) for List transcripts to return, in any ISO 8601 compliant format. to cannot be before from.

documentation: https://developer.webex.com/docs/api/v1/meeting-transcripts/list-meeting-transcripts

list_compliance_officer(site_url: str, from_: str | None = None, to_: str | None = None, **params) → Generator[Transcript, None, None][source]

Lists available or deleted transcripts of an ended meeting instance for a specific site. The returned list is sorted in descending order by the date and time that the transcript was created.

Parameters:

  • site_url (str) – URL of the Webex site from which the API lists transcripts.

  • from (str) – Starting date and time (inclusive) for transcripts to return, in any ISO 8601 compliant format. from cannot be after to.

  • to (str) – Ending date and time (exclusive) for List transcripts to return, in any ISO 8601 compliant format. to cannot be before from.

documentation: https://developer.webex.com/docs/api/v1/meeting-transcripts/list-meeting-transcripts-for -compliance-officer

download(transcript_id: str, format: str | None = None, host_email: str | None = None)[source]

Download a meeting transcript from the meeting transcript specified by transcriptId.

Parameters:

  • transcript_id (str) – Unique identifier for the meeting transcript.

  • format (str) – Format for the downloaded meeting transcript. Possible values: vtt, txt

  • host_email (str) – Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API will return details for a meeting that is hosted by that user.

documentation: https://developer.webex.com/docs/api/v1/meeting-transcripts/download-a-meeting-transcript

list_snippets(transcript_id: str, **params) → Generator[TranscriptSnippet, None, None][source]

Lists snippets of a meeting transcript specified by transcriptId. Use this operation to list snippets of a meeting transcript when they are ready.

Parameters:

transcript_id (str) – Unique identifier for the meeting transcript to which the snippets belong.

documentation: https://developer.webex.com/docs/api/v1/meeting-transcripts/list-snippets-of-a-meeting-transcript

snippet_detail(transcript_id: str, snippet_id: str) → TranscriptSnippet[source]

Retrieves details for a transcript snippet specified by snippetId from the meeting transcript specified by transcriptId.

Parameters:

  • transcript_id (str) – Unique identifier for the meeting transcript to which the requested snippet belongs.

  • snippet_id (str) – Unique identifier for the snippet being requested.

documentation: https://developer.webex.com/docs/api/v1/meeting-transcripts/get-a-transcript-snippet

update_snippet(transcript_id: str, snippet_id: str, text: str, reason: str | None = None) → TranscriptSnippet[source]

Updates details for a transcript snippet specified by snippetId from the meeting transcript specified by transcriptId.

Parameters:

  • transcript_id (str) – Unique identifier for the meeting transcript to which the snippet to be updated belongs.

  • snippet_id (str) – Unique identifier for the snippet being updated.

  • text (str) – Text for the snippet.

  • reason (str) – Reason for snippet update; only required for Compliance Officers.

documentation: https://developer.webex.com/docs/api/v1/meeting-transcripts/update-a-transcript-snippet

delete(transcript_id: str, reason: str | None = None, comment: str | None = None)[source]

Removes a transcript with a specified transcript ID. The deleted transcript cannot be recovered. If a Compliance Officer deletes another user’s transcript, the transcript will be inaccessible to regular users (host, attendees), but will be still available to the Compliance Officer.

Parameters:

  • transcript_id (str) – Unique identifier for the meeting transcript.

  • reason (str) – Reason for deleting a transcript. Only required when a Compliance Officer is operating on another user’s transcript.

  • comment (str) – Explanation for deleting a transcript. The comment can be a maximum of 255 characters long.

documentation: https://developer.webex.com/docs/api/v1/meeting-transcripts/delete-a-transcript

base = ''
class wxc_sdk.meetings.transcripts.TranscriptSnippet(*, id: str | None = None, text: str | None = None, personName: str | None = None, personEmail: str | None = None, offsetMillisecond: int | None = None, durationMillisecond: int | None = None)[source]

Bases: ApiModel

id: str | None

A unique identifier for the snippet.

text: str | None

Text for the snippet.

person_name: str | None

Name of the person generating the speech for the snippet.

person_email: str | None

Email address of the person generating the speech for the snippet.

offset_millisecond: int | None

Offset from the beginning of the parent transcript in milliseconds indicating the start time of the snippet.

duration_millisecond: int | None

Duration of the snippet in milliseconds.

class wxc_sdk.meetings.transcripts.TranscriptStatus(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

available = 'available'

Transcript is available.

deleted = 'deleted'

Transcript has been deleted.

class wxc_sdk.meetings.transcripts.Transcript(*, id: str | None = None, siteUrl: str | None = None, startTime: str | None = None, meetingTopic: str | None = None, meetingId: str | None = None, scheduledMeetingId: str | None = None, meetingSeriesId: str | None = None, hostUserId: str | None = None, vttDownloadLink: str | None = None, txtDownloadLink: str | None = None, status: TranscriptStatus | None = None)[source]

Bases: ApiModel

id: str | None

A unique identifier for the transcript.

site_url: str | None

URL of the Webex site from which the API lists meeting transcripts.

start_time: str | None

Start time for the meeting transcript in ISO 8601 compliant format.

meeting_topic: str | None

The meeting’s topic.

meeting_id: str | None

Unique identifier for the meeting instance to which the transcripts belong.

scheduled_meeting_id: str | None

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.

meeting_series_id: str | None

Unique identifier for the parent meeting series to which the recording belongs.

host_user_id: str | None

Unique identifier for the meeting host.

The download link for the transcript vtt file.

The download link for the transcript txt file.

status: TranscriptStatus | None
class wxc_sdk.meetings.transcripts.UpdateTranscriptSnippetBody(*, reason: str | None = None, text: str | None = None)[source]

Bases: ApiModel

reason: str | None

Reason for snippet update; only required for Compliance Officers.

text: str | None

Text for the snippet.

class wxc_sdk.meetings.transcripts.DeleteTranscriptBody(*, reason: str | None = None, comment: str | None = None)[source]

Bases: ApiModel

reason: str | None

Reason for deleting a transcript. Only required when a Compliance Officer is operating on another user’s transcript.

comment: str | None

Explanation for deleting a transcript. The comment can be a maximum of 255 characters long.