# Calls Recording Recording capabilities are provided by server component called VidyoReplay. Your VidyoPlatform tenant should contain VidyoReplay component configured in advance in order to make calls recording. All the API methods are SOAP based, and you can find entire API reference guide document here: In this article we will cover how to start and stop recording, how to ensure the recording process has been started successfully, and how to search and download recording file. ## Start Recording At first, in order to record the conference, you need to have a room created, and at least one participant connected to that room. ### Create a Room We will be using Scheduled type of rooms onwards. So let's create one using **VidyoPortalUserService** and **CreateScheduledRoom** API: ```xml ``` You will receive a response containing various fields as showed in [Getting Started](/vidyoplatform/getting-started.md#obtain-and-understand-the-response), but here we will need only **roomURL** response field value: ```xml https://test.platform.vidyo.io/join/Nf5kaN9tWo ``` And even not entire room link, but **RoomKey** specifically: Nf5kaN9tWo ### Get ConferenceID (EntityID) For this we will use **GetEntityByRoomKey** API, passing in above **RoomKey** value: ```xml Nf5kaN9tWo ``` Response object will contain a lot of fields about the room you just created, but you will need the first one - **entityID**, that in this case is 4092486**:** ```xml 4092486 Room 156418 230301302 ..... ``` ### Select Recorder Prefix There is a **Recording Profile** - it basically specifies what and how to record - video tiles and content share, content share only or preferably, etc. So it's a mode that you select based on your needs. Recording profiles are configured on a Tenant level, so in reality you will not need to retrieve the list of available recording profiles each time you start the recording. However, you can use **GetRecordingProfiles** API to be sure of available recording profiles configured on your system: ```xml ``` Here is the typical response, and we will need **recorderPrefix** field value, let's take 000 that means APPLICATION-AND-CONFERENCE recording mode. ### Start Recording At this point we have all necessary information required to start the recording: * [ ] ConferenceID = 4092486 * [ ] RecorderPrefix = 000 So, let's use **StartRecording** API to actually start the recording process: ```xml 4092486 000 false ``` After sending above request you should expect an HTTP200-OK response. {% hint style="info" %} **StartRecordingResponse** of HTTP200 doesn't necessarily mean that VidyoReplay actually started recording the conference. How to ensure the recording has been indeed started is covered later in this article. {% endhint %} ## Stop Recording For stopping ongoing recording we will need to know **ConferenceID** and **RecorderID** values. ### Get RecorderID When the conference is being recorded by VidyoReplay it technically means that VidyoReplay has also joined the call, and you can think of it as of another participant in the call. Therefore, at this step we will get information about participants in the conference that is being recorded, and extract RecorderID. For this we will use GetParticipants API, passing in **ConferenceID** value: ```xml 4092486 ``` Below is a chunk of the typical response you will receive, that contains **recorderID** field: 1109054 ```xml 1 1109054 APPLICATION-AND-CONFERENCE false false 0 6611572 ... ``` {% hint style="info" %} Note that if **recorderID** is not present in the response, that it means that the conference is not being recorded. {% endhint %} So, at this stage we have all we need for stopping the recording: * [ ] ConferenceID = 4092486 * [ ] RecorderID = 1109054 ### Stop recording For this we will use **StopRecording** API: ```xml 4092486 1109054 ``` ## Pause and Resume Recording For pausing and resuming ongoing recording you can use **PauseRecording** and **ResumeRecording** APIs accordingly. Each of these requires the same **ConferenceID** and **RecorderID** parameters. ## Search Recordings Once the call has ended and recording has been completed, you typically may need to find this or any other recording file. All the recording are being stored on the **VidyoReplay** server, and it has its own set of APIs the allow search, update, and delete recordings. In cloud Vidyo environments the wsdl URI will look as the following: https\://{TenantName}.replay.platform.vidyo.io/replay/services/VidyoReplayContentManagementService?wsdl To search for recording you will have to use **RecordsSearch** API. Example: ```xml test vova date ASC 100 ``` The above request filters recordings on VidyoReplay and returns those which are made on the tenant with name containing "test", recorded by user "vova", then sorts results by date in ascending order, and finally limits results number to 100. As you can see, there are more filters to apply in request body that allows you to construct your search really precisely if needed. Here what the response chunk looks like: ```xml 37 9 37 0 37 0 0 0 4908 bce75e5c-e850-5c4c-8f1e-c9b705eff420 VidyoTest vova Vova Tareiev 2022-08-08T09:48:44.000+00:00 Mon August 8 2022 09:48:44 2022-08-08T09:50:32.000+00:00 01:48 HD 30 New vova conference recording. vova https://test.replay.platform.vidyo.io/replay/downloadRecording.do?file=bce75e5c-e850-5c4c-8f1e-c9b705eff420 421aa0067 false false https://test.replay.platform.vidyo.io/replay/showRecordingExternal.html?key=IG3bxGBxhaiknT8 1493016 5748 37b8355d-e84c-53bc-8a53-478c15384f13 VidyoTest vova Vova Tareiev 2022-09-22T10:46:04.000+00:00 Thu September 22 2022 10:46:04 2022-09-22T10:50:03.000+00:00 03:59 HD 30 New vova conference recording. vova https://test.replay.platform.vidyo.io/replay/downloadRecording.do?file=37b8355d-e84c-53bc-8a53-478c15384f13 421aa0067 false false https://test.replay.platform.vidyo.io/replay/showRecordingExternal.html?key=b09ExKntmYcd9h9 3258210 [...] ``` As you can see, the response contains some general information about total recording such as overall count and found number, as well as list of nodes - each for specific found recording. ## Download Recording There are two options of how you can download the recording. First is manual - you simply go to your **VidyoReplay** server Admin Manager ([https://{TenantName}.replay.platform.vidyo.io/replay](https://test.replay.platform.vidyo.io/replay/)) and click a button to download. Another options that you definitely will like better is to do this programmatically by simply using common tools such as **wget** or **curl:** ```bash curl -H "Authorization: Basic dGFyYXM6cXrlcjA2MjI=" "https://{TenantName}.replay.platform.vidyo.io/replay/downloadRecording.do?file=2ffdffd7-c66d-5ba0-9ff4-2810c54fc968" --output recording.mp4 ``` where first argument is a header with your Base64-encoded auth, second is fileLink field from the RecordsSearch response above, and finally an output file name.
--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://enghouse-vidyo.gitbook.io/vidyoplatform/use-cases/calls-recording.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.