List Meeting Transcripts
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.
Request Header
timezone
: Time zone in conformance with the IANA time zone database. The default is UTC iftimezone
is not defined.
Query Parameters
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.
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
.
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.
Starting date and time (inclusive) for transcripts to return, in any ISO 8601 compliant format. from
cannot be after to
.
Ending date and time (exclusive) for List transcripts to return, in any ISO 8601 compliant format. to
cannot be before from
.
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
.
Response Properties
Transcript array.
A unique identifier for the transcript.
URL of the Webex site from which the API lists meeting transcripts.
Start time for the meeting transcript in ISO 8601 compliant format.
The meeting's topic.
Unique identifier for the meeting instance to which the transcripts belong.
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.
Unique identifier for the parent meeting series to which the recording belongs.
Unique identifier for the meeting host.
The download link for the transcript vtt file.
The download link for the transcript txt file.
Transcript is available.
Transcript has been deleted.
Response Codes
The list below describes the common success and error responses you should expect from the API.
Code | Status | Description |
---|---|---|
200 | OK | Successful request with body content. |
201 | Created | The request has succeeded and has led to the creation of a resource. |
202 | Accepted | The request has been accepted for processing. |
204 | No Content | Successful request without body content. |
400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
401 | Unauthorized | Authentication credentials were missing or incorrect. |
403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
410 | Gone | The requested resource is no longer available. |
415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
503 | Service Unavailable | Server is overloaded with requests. Try again later. |
504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- meetingIdstringUnique 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.
- hostEmailstringEmail 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`.
- siteUrlstringURL 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.
- fromstringStarting 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`.
- tostringEnding 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`.
- maxnumberMaximum 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`.
{ "items": [ { "id": "8ce1f918-c138-4041-bb4a-5e01eeaadedb_M_0fc6ec11d9b6c909e04e1f6c76accda9", "startTime": "2020-06-02T20:30:15.042Z", "meetingId": "0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044", "meetingTopic": "John's Meeting 01", "siteUrl": "example.webex.com", "scheduledMeetingId": "0ed74a1c0551494fb7a04e2881bf50ae_20210401T232500Z", "meetingSeriesId": "0ed74a1c0551494fb7a04e2881bf50ae", "hostUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83QkFCQkU5OS1CNDNFLTREM0YtOTE0Ny1BMUU5RDQ2QzlDQTA", "vttDownloadLink": "http://site-example.webex.com/v1/meetingTranscripts/5e01eeaadedb_M_0fc6ec11d9b6c909e04e1f6c76accda9/download?format=vtt", "txtDownloadLink": "http://site-example.webex.com/v1/meetingTranscripts/5e01eeaadedb_M_0fc6ec11d9b6c909e04e1f6c76accda9/download?format=txt", "status": "available" }, { "id": "074d892d-c7f7-4864-95db-31f7ae94206f_M_39f4371ca39c4a98b7f6ecc74247151e", "startTime": "2020-06-01T20:30:15.042Z", "meetingId": "0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044", "meetingTopic": "John's Meeting 02", "siteUrl": "example.webex.com", "scheduledMeetingId": "0ed74a1c0551494fb7a04e2881bf50ae_20210401T232500Z", "meetingSeriesId": "0ed74a1c0551494fb7a04e2881bf50ae", "hostUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83QkFCQkU5OS1CNDNFLTREM0YtOTE0Ny1BMUU5RDQ2QzlDQTA", "vttDownloadLink": "http://site-example.webex.com/v1/meetingTranscripts/31f7ae94206f_M_39f4371ca39c4a98b7f6ecc74247151e/download?format=vtt", "txtDownloadLink": "http://site-example.webex.com/v1/meetingTranscripts/31f7ae94206f_M_39f4371ca39c4a98b7f6ecc74247151e/download?format=txt", "status": "available" } ] }