Meeting Closed Captions - List Meeting Closed Captions

List Meeting Closed Captions

Lists closed captions of a finished meeting instance specified by meetingId.

Closed captions are ready 15 minutes after the meeting is finished.
Only meeting instances in state ended are supported for meetingId. Meeting series, scheduled meetings and in-progress meeting instances are not supported.
Currently, a meeting may have only one closed caption associated with its meetingId. The response is a closed captions array, which may contain multiple values to allow for future expansion, but currently only one closed caption is included in the response.

GET/v1/meetingClosedCaptions

Query Parameters

meetingId

stringrequired

Unique identifier for the meeting instance which the closed captions belong to. This parameter only applies to ended meeting instnaces. It does not apply to meeting series, scheduled meetings or scheduled personal room meetings.

Response Properties

items

array[ClosedCaptionObject]

Closed caption array

string

A unique identifier for the closed caption.

meetingId

string

Unique identifier for the meeting instance which the closed captions belong to.

vttDownloadLink

string

The download link for the closed caption vtt file.

txtDownloadLink

string

The download link for the closed caption txt file.

start

string

Start time for the meeting closed caption in ISO 8601 compliant format.

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.

GET

/v1/meetingClosedCaptions{?meetingId}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

meetingId
stringRequired
Unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) which the closed captions belong to. This parameter only applies to ended meeting instnaces. It does not apply to meeting series, scheduled meetings or scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meetings.

https://webexapis.com/v1/meetingClosedCaptions?meetingId=0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044

200 / OK

{
    "items": [
        {
            "id": "195d64646ad14be2924ea50f541fd91d",
            "meetingId": "0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044",
            "vttDownloadLink": "http://site-example.webex.com/v1/meetingClosedCaptions/195d64646ad14be2924ea50f541fd91d/download?format=vtt",
            "txtDownloadLink": "http://site-example.webex.com/v1/meetingClosedCaptions/195d64646ad14be2924ea50f541fd91d/download?format=txt",
            "start": "2022-04-18T01:46:29Z"
        }
    ]
}