{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Transcripts API", "version": "1.0.0" }, "items": [ { "info": { "name": "Transcripts", "type": "folder" }, "items": [ { "info": { "name": "List Meeting Transcripts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meetingTranscripts", "params": [ { "name": "max", "value": "", "type": "query", "description": "Maximum number of transcripts to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`." }, { "name": "from", "value": "2020-07-12T09:30:00+08:00", "type": "query", "description": "Starting date and time (inclusive) for transcripts to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`." }, { "name": "to", "value": "2020-07-31T09:30:00+08:00", "type": "query", "description": "Ending date and time (exclusive) for List transcripts to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`." }, { "name": "meetingId", "value": "0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044", "type": "query", "description": "Unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the transcript belongs. Please note that currently the meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) 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." }, { "name": "hostEmail", "value": "john.andersen@example.com", "type": "query", "description": "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`." }, { "name": "siteUrl", "value": "example.webex.com", "type": "query", "description": "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](/docs/api/v1/meeting-preferences/get-site-list) API." } ] }, "docs": "Lists available transcripts of an ended [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances).\n\nUse this operation to list transcripts of an ended [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) 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.\n\n#### Requ" }, { "info": { "name": "List Meeting Transcripts For Compliance Officer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/meetingTranscripts", "params": [ { "name": "from", "value": "2020-07-12T09:30:00+08:00", "type": "query", "description": "Starting date and time (inclusive) for transcripts to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`." }, { "name": "to", "value": "2020-07-31T09:30:00+08:00", "type": "query", "description": "Ending date and time (exclusive) for List transcripts to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`." }, { "name": "max", "value": "", "type": "query", "description": "Maximum number of transcripts to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`." }, { "name": "siteUrl", "value": "example.webex.com", "type": "query", "description": "URL of the Webex site from which the API lists transcripts." } ] }, "docs": "Lists available or deleted transcripts of an ended [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for a specific site.\n\nThe returned list is sorted in descending order by the date and time that the transcript was created.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is" }, { "info": { "name": "Download a Meeting Transcript", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meetingTranscripts/:transcriptId/download", "params": [ { "name": "transcriptId", "value": "5e01eeaadedb_M_0fc6ec11d9b6c909e04e1f6c76accda9", "type": "path", "description": "Unique identifier for the meeting transcript." }, { "name": "format", "value": "vtt", "type": "query", "description": "Format for the downloaded meeting transcript." }, { "name": "hostEmail", "value": "john.andersen@example.com", "type": "query", "description": "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." } ] }, "docs": "Download a meeting transcript from the meeting transcript specified by `transcriptId`." }, { "info": { "name": "List Snippets of a Meeting Transcript", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meetingTranscripts/:transcriptId/snippets", "params": [ { "name": "transcriptId", "value": "195d64646ad14be2924ea50f541fd91d", "type": "path", "description": "Unique identifier for the meeting transcript to which the snippets belong." }, { "name": "max", "value": "10", "type": "query", "description": "Maximum snippet items to be returned for this query, to support pagination." } ] }, "docs": "Lists snippets of a meeting transcript specified by `transcriptId`.\n\nUse this operation to list snippets of a meeting transcript when they are ready." }, { "info": { "name": "Get a Transcript Snippet", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meetingTranscripts/:transcriptId/snippets/:snippetId", "params": [ { "name": "transcriptId", "value": "195d64646ad14be2924ea50f541fd91d", "type": "path", "description": "Unique identifier for the meeting transcript to which the requested snippet belongs." }, { "name": "snippetId", "value": "195d64646ad14be2924ea50f541fd91d_00001", "type": "path", "description": "Unique identifier for the snippet being requested." } ] }, "docs": "Retrieves details for a transcript snippet specified by `snippetId` from the meeting transcript specified by `transcriptId`." }, { "info": { "name": "Update a Transcript Snippet", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meetingTranscripts/:transcriptId/snippets/:snippetId", "params": [ { "name": "transcriptId", "value": "195d64646ad14be2924ea50f541fd91d", "type": "path", "description": "Unique identifier for the meeting transcript to which the snippet to be updated belongs." }, { "name": "snippetId", "value": "195d64646ad14be2924ea50f541fd91d_00001", "type": "path", "description": "Unique identifier for the snippet being updated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates details for a transcript snippet specified by `snippetId` from the meeting transcript specified by `transcriptId`." }, { "info": { "name": "Delete a Transcript", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/meetingTranscripts/:transcriptId", "params": [ { "name": "transcriptId", "value": "195d64646ad14be2924ea50f541fd91d", "type": "path", "description": "Unique identifier for the meeting transcript." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." } ] } ], "bundled": true }