Addon Required
The Luware Recording APIs require an additional license addon for your environment. Contact solutions@luware.com or your customer success specialist for more information.
This page provides an overview of the Luware Recording API flow and the available endpoints used to interact with the Luware Recording environment. It outlines the standard sequence of API actions; from authentication and conversation search to performing recording-related operations and includes detailed descriptions of each endpoint. This information is intended to support integrations and automation using the Luware Recording API.
Flow sequence
To use the Luware Recording APIs a standard flow of actions should be performed.
- Request token: Using the provided API credentials a request for a token must be sent to the FQDN of the Luware Recording environment, including the customer specific environment identifier.
- Conversation search: A search must be performed to find specific unique call identifiers, referred to as CCDRIDs or conversation identifiers. This identifier is used to perform actions on specific recordings during the next stage. At this stage, it's also possible to retrieve call metadata if that is the only requirement of the API integration.
- Perform an action: An action can be performed on the Luware Recording environment at this stage, for example, add a label, start or stop a recording or extract speech analytics files. To identify the specific record, the CCDRID, which is the unique identifier of a recording, must be used.
- Loop using existing token: You can continue to use the same token to perform additional searches and/or actions to reduce API usage.
- Token expiry: After 60 minutes the token will expire, the integration must now request a new token to continue with other requests.
Endpoint summary
Luware Recording currently has the below endpoints available for use:
| Endpoint | Description |
vfcrest/v1/auth/token |
Request a temporary token to perform API queries. |
vfcrest/v1/conversations |
Search and list recorded conversation metadata. |
vfcrest/v1/conversations/{ccdrid} |
Retrieve metadata for a unique conversation recording. |
vfcrest/v1/conversations/{ccdrid}/media |
Retrieve the Speech Analytics voice transcript file for a unique conversation recording. |
vfcrest/v1/conversations/{ccdrid}/metadata |
Add metadata to a unique conversation recording. |
vfcrest/v1/conversations/{ccdrid}/labels |
Add a label to a unique conversation recording. |
vfcrest/v1/conversationControl/{ccdrid} |
Perform start or stop actions for controlled recording or mark conversations to be kept if using on-demand recording. |
Endpoints
Request access token
Request an access token. The API uses standard JWT (JSON Web Tokens) signed by Luware Recording. In order to request a token, you need to provide the API Username and the API password which will be provided by Luware.
POST /v1/auth/token
Request
| URI | Description | Mandatory | Example |
| POST | The method required for the API endpoint. | Yes | POST |
| <URI> | Luware will provide the relevant URI to send requests to during onboarding or via support channels. | Yes | https://example.luware.com |
| /v1/auth/token | The initial endpoint to send the request. | Yes | /v1/auth/token |
| Headers | Description | Mandatory | Example |
| Ocp-Apim-Subscription-Key | Unique API subscription key for your customer environment. | Yes | 159b3228-f741-4e4a-88aa-ea70ad320783 |
| Body | Description | Mandatory | Example |
| eid | The environment identifier (EID) number for your Luware Recording environment. | Yes | 1000 |
| client_id |
The API username provided by Luware. Must be URL encoded. For information on URL encoding visit: |
Yes | api_user%40luware.com |
| client_secret |
The API password provided by Luware. Must be URL encoded. For more information on URL encoding visit:
Do not enter client secrets into URL encoding convertors. |
Yes | password%401234 |
Responses
| Code | Description |
| 200 |
Successful operation Example response: { "access_token": "fL9QPL2U667bBpi…", }
|
| 400 | Invalid request, check the required headers and parameters are included. |
| 401 | Invalid credentials, check header and parameter values are URL encoded. |
| 403 | Forbidden request, check headers and parameters are included. |
| 404 | Not found, recommend raising a support case. |
| 405 | Not allowed, recommend raising a support case. |
| 409 | Already exists, recommend raising a support case. |
| 500 | Internal server error, recommend raising a support case. |
| 502 | Bad gateway, recommend raising a support case. |
Search and list recorded conversations
A request to this endpoint will retrieve a list of the conversations based on the filters provided. The maximum returned in a single request is 100 records. NextPageToken must be used with the request to retrieve the next set of results.
GET vfcrest/v1/conversations
Request
| URI | Description | Mandatory | Example |
| GET | The method required for the API endpoint. | Yes | GET |
| <URI> | Luware will provide the relevant URI to send requests to during onboarding or via support channels. | Yes | https://example.luware.com |
| vfcrest/v1/conversations | The initial endpoint to send the request. | Yes | vfcrest/v1/conversations |
| Headers | Description | Mandatory | Example |
| Ocp-Apim-Subscription-Key | Unique API subscription key for your customer environment. | Yes | 159b3228-f741-4e4a-88aa-ea70ad320783 |
| Authorization: Bearer | The access_token received from the v1/token/auth endpoint. | Yes | fL9QPL2U667bBpitMFhtNIn2kLHC15WB |
| URL Parameters | Description | Mandatory | Example |
Using URL Parameters✅ To use the below URL parameters, you must include a ? symbol prior to the below parameters, for example: vfcrest/v1/conversations?limit=100 | |||
| limit | The maximum number of records to be returned from the query, the limit is 100. Any number exceeding 100 will return only 100 records. | Yes | limit=100 |
| sortBy |
Enables sorting conversations by ascending or descending start time. Ascending occurs by default. Requires the sortOrder field to be included.
Options: startTime |
No | sortBy=startTime |
| sortOrder |
Enables sorting conversations by ascending or descending start time. Ascending occurs by default. Requires the sortBy field to be included.
Options: asc|desc |
No | sortBy=desc |
| filters |
Enables the filtering of captured conversations using a large proportion of the available fields stored in the database. Use the filterlist table below to determine the field mapping, data types and available operators.
Options: Use the filterlist table below |
Yes | filters={'filtersList': [{'field': 'startTime', 'operator': 'GREATER_THAN_OR_EQUAL', 'values': ['2024-07-01 00:00:00.000']}]} |
| nextPageToken |
Retrieves the next set of results found by the search query. For example, the first query returns 100 results and a nextPageToken in the body. To retrieve results 101 to 200 use the nextPageToken in the URL parameters.
The value for the nextPageToken is found in the body of the initial API request.
All other URL parameters must be removed to use nextPageToken. |
No |
nextPageToken= 4ifAzqxn7a8reE3ZxQ2qFT7reE3Zxdgr… |
Filterlist
| Field | Corresponding Field | Data type | Description | Operators | Example |
| ccdrId | Conversation Identifier | string | The unique identifier within Luware Recording for a specific captured conversation | EQUAL | 5399f478-aa0b-4834-b64f-211ecca0c74a |
| platformCallId | Platform Conversation ID | string | The platform conversation identifier provided by the communication platform. Many recorded conversations can share the same platform conversation identifier, for example, in a Microsoft Teams meeting. This field is the Microsoft-Skype-ChainId in Microsoft Teams. | EQUAL | 5399f478-aa0b-4834-b64f-211ecca0c74a |
| startTime | Start Time | string($date-time) | The start time of the conversation converted to the user's time zone |
GREATER_THAN_OR_EQUAL GREATER_THAN LESS_THAN_OR_EQUAL LESS_THAN BETWEEN |
2024-07-01 00:00:00.000 |
| endTime | End Time | string($date-time) | The end time of the conversation converted to the user's time zone |
GREATER_THAN_OR_EQUAL GREATER_THAN LESS_THAN_OR_EQUAL LESS_THAN BETWEEN |
2024-07-01 00:00:00.000 |
| verbaUserName | User | string | Name of the associated Verba User |
EQUAL NOT_EQUAL STARTS_WITH ENDS_WITH |
Firstname Lastname |
| verbaUserLogin | Login ID | string | Login ID of the associated Verba User |
EQUAL NOT_EQUAL STARTS_WITH ENDS_WITH |
user1@domain.com |
| agentId | User ID | string | Agent / User ID provided by the communication platform |
EQUAL NOT_EQUAL STARTS_WITH ENDS_WITH |
5399f478-aa0b-4834-b64f-211ecca0c74a |
| status | N/A | string |
The current status of the recording, for example, is it currently ongoing.
Options include: ongoing |
EQUAL NOT_EQUAL |
ongoing |
| recordedParty | N/A | integer($int32) | Signals whether the "From" (0) or the "To" (1) party was the recorded participant (or null if it is unknown) |
EQUAL NOT_EQUAL |
NULL 0 1 |
| sourceName | From Info | string | Caller name ("From Info") |
EQUAL NOT_EQUAL STARTS_WITH ENDS_WITH |
+44123456789 |
| sourceCallerId | From | string | Caller ID ("From") |
EQUAL NOT_EQUAL STARTS_WITH ENDS_WITH |
+44123456789 |
| destinationName | To Info | string | Called name ("To Info") |
EQUAL NOT_EQUAL STARTS_WITH ENDS_WITH |
+44123456789 |
| destinationCallerId | To | string | Called ID ("To") |
EQUAL NOT_EQUAL STARTS_WITH ENDS_WITH |
+44123456789 |
| modalityName | Conversation Type | string | The modality of the conversation (see the d_modality table) |
EQUAL NOT_EQUAL STARTS_WITH ENDS_WITH |
file_share im share video voice |
| cause | End Cause | string | The end cause of the conversation recording. |
EQUAL NOT_EQUAL |
Normal From Terminated To Terminated Hold Transfer Caller gave up Busy Unobtainable Error Conference Call park Join Direct Transfer Line change Timeout Forced termination Manual termination Program termination Video escalation Voice Inactivity Media Segmentation Blocked Unknown |
| direction | Direction | string | ID of the Storage Target where the media files are uploaded. To retrieve the storage target identifier, go to Data, Storage targets and the id field is listed. |
EQUAL NOT_EQUAL STARTS_WITH ENDS_WITH |
internal incoming outgoing inter-tenant undefined external federated-in federated-out contact-center-in contact-center-out conference |
| storageFolderId | N/A | integer($int32) | ID of the Storage Target where the media files are uploaded to (reference to the storage_folder table) |
EQUAL NOT_EQUAL |
1 |
| retentionUntil | End of Retention | string($date-time) | The end date and time of the recorded conversation retention. |
GREATER_THAN_OR_EQUAL GREATER_THAN LESS_THAN_OR_EQUAL LESS_THAN BETWEEN |
2024-07-01 00:00:00.000 |
| retentionAutoDelete | Delete after End of Retention | boolean | If it is true, then the conversation will be deleted automatically after the retention is over |
EQUAL NOT_EQUAL |
TRUE FALSE |
| nativeId | Technical ID | string | Identifier provided by the communication platform | EQUAL | 5399f478-aa0b-4834-b64f-211ecca0c74a |
| secondary | 2N Source | boolean | If true, then it is a Secondary recording in a 2N setup |
EQUAL NOT_EQUAL |
TRUE FALSE |
| hold | Legal Hold | integer($int32) |
Signals if the conversation is under Legal Hold. Possible values are: NULL: not under Legal Hold 1: under Legal Hold because got a Legal Hold Label 2: the Media-Only record is under Legal Hold because a referencing CDR-Only Record is under Legal Hold 3: the Media-Only record is under Legal Hold because got a Legal Hold Label and a referencing CDR-Only Record is under Legal Hold too |
EQUAL NOT_EQUAL |
NULL 1 2 3 |
| cdrMediaType | Record Type | integer($int32) |
Record Type: 0: Normal 1: CDR-Only 2: Media-Only |
EQUAL NOT_EQUAL |
0 1 2 |
| sourceAudioRtpCount | From RTP Packets | integer($int32) | "From" Audio RTP count |
GREATER_THAN_OR_EQUAL GREATER_THAN LESS_THAN_OR_EQUAL LESS_THAN BETWEEN |
500 |
| destinationAudioRtpCount | To RTP Packets | integer($int32) | "To" Audio RTP count |
GREATER_THAN_OR_EQUAL GREATER_THAN LESS_THAN_OR_EQUAL LESS_THAN BETWEEN |
500 |
| platformName | Source Platform | string | The name of the source communication platform that the recording was captured from. |
EQUAL NOT_EQUAL |
BroadSoft SIPREC Cisco Network Based Generic RTP Generic SIPREC IP Trade Generic SIP Speakerbus Truphone Cloud9 Symphony IPC Unigy Metaswitch Perimeta SIPREC SMS (SMPP) Bloomberg IM Generic Verba REST API Microsoft Teams Microsoft Teams IM Zoom Phone Zoom Meeting Vodafone WebEx GenesysCloud |
| importSourceId | N/A | integer($int32) | The import source id of the import source used to import a recording into Luware Recording. Can be found in the conversation details or by navigating to Data, Import sources. |
EQUAL NOT_EQUAL |
1 |
| importSourceName | Import Source | string | The name of the import source used to import a recording into Luware Recording. Can be found in the conversation details or by navigating to Data, Import sources. |
EQUAL NOT_EQUAL STARTS_WITH ENDS_WITH |
Legacy Import |
| forwardReasonName | Forward Reason | string | Forward Reason |
EQUAL NOT_EQUAL STARTS_WITH ENDS_WITH |
All Forwarded Transferred Team Call Delegated Response Group ACD |
| meetingId | Meeting ID | string | The unique meeting identifier created by Microsoft. Specifically only for Microsoft Teams conference calls. |
EQUAL NOT_EQUAL STARTS_WITH ENDS_WITH |
19:meeting_NWVjAGZjZmMtNzliOC00MWM2LTk4YnEtNjc1ZTMqMTkzZGYw@thread.v2 |
| priv | N/A | boolean | Signals whether the associated Verba User marked this conversation as Private |
EQUAL NOT_EQUAL |
TRUE FALSE |
| ondemand | N/A | boolean | Signals whether this is an on-demand recorded conversation |
EQUAL NOT_EQUAL |
TRUE FALSE |
| keep | N/A | boolean | Signals whether the on-demand conversation was marked for recording |
EQUAL NOT_EQUAL |
TRUE FALSE |
| doNotDelete | N/A | integer($int32) | The Protected flag (this feature is obsolete); if 1, then it is marked as Protected, if negative, then the recording should be deleted |
EQUAL NOT_EQUAL |
1 2 |
Responses
| Code | Description |
| 200 |
Successful operation Example response: {
|
| 400 | Invalid request, check the required headers and parameters are included. |
| 401 | Invalid credentials, check header and parameter values are URL encoded. |
| 403 | Forbidden request, check headers and parameters are included. |
| 404 | Not found, recommend raising a support case. |
| 405 | Not allowed, recommend raising a support case. |
| 409 | Already exists, recommend raising a support case. |
| 500 | Internal server error, recommend raising a support case. |
| 502 | Bad gateway, recommend raising a support case. |
Retrieve Speech Analytics output file for a recording
Download the Speech Analytics output file is speech analytics is enabled on your environment. Use the unique conversation identifier {ccdrid} available using the /conversations endpoint and stream the file for use in external systems.
GET vfcrest/v1/conversations/{ccdrid}/media
Request
| URI | Description | Mandatory | Example |
| GET | The method required for the API endpoint. | Yes | GET |
| <URI> | Luware will provide the relevant URI to send requests to during onboarding or via support channels. | Yes | https://example.luware.com |
| vfcrest/v1/conversations/{ccdrid}/media | The initial endpoint to send the request. | Yes | vfcrest/v1/conversations/5399f478-aa0b-4834-b64f-211ecca0c74a/media |
| Headers | Description | Mandatory | Example |
| Ocp-Apim-Subscription-Key | Unique API subscription key for your customer environment. | Yes | 159b3228-f741-4e4a-88aa-ea70ad320783 |
| Authorization: Bearer | The access_token received from the v1/token/auth endpoint. | Yes | fL9QPL2U667bBpitMFhtNIn2kLHC15WB |
| URL Parameters | Description | Mandatory | Example |
| ccdrId | The unique identifier within Luware Recording for a specific captured conversation. The matching field in the web portal is Conversation Identifier. | Yes | 5399f478-aa0b-4834-b64f-211ecca0c74a |
Using URL ParametersTo use the below URL parameters, you must include a ? symbol prior to the below parameters, for example: fcrest/v1/conversations/{ccdrid}/media?fileExtension=vtr | |||
| fileExtension | Pulls the Speech Analytics output file | Yes | fileExtension=vtr |
Responses
| Code | Description |
| 200 |
Successful operation Stream: File downloaded: _AlexW%405nt7vp.onmicrosoft.com--MeganB%405nt7vp.onmicrosoft.com2025-03-0614-36.vtr File is compressedThe .vtr file is a compressed .zip file that needs to be uncompressed for use. For example, convert the file extension from to .vtr to .zip and decompress the file, then the .vtr file can be read as a JSON file type. |
| 400 | Invalid request, check the required headers and parameters are included. |
| 401 | Invalid credentials, check header and parameter values are URL encoded. |
| 403 | Forbidden request, check headers and parameters are included. |
| 404 | Not found, recommend raising a support case. |
| 405 | Not allowed, recommend raising a support case. |
| 409 | Already exists, recommend raising a support case. |
| 500 | Internal server error, recommend raising a support case. |
| 502 | Bad gateway, recommend raising a support case. |
Add metadata to a conversation recording
Add metadata to a recording using existing metadata templates created for your Luware Recording environment. To create a new metadata template for your environment contact support.
POST vfcrest/v1/conversations/{ccdrid}/metadata
Request
| URI | Description | Mandatory | Example |
| POST | The method required for the API endpoint. | Yes | POST |
| <URI> | Luware will provide the relevant URI to send requests to during onboarding or via support channels. | Yes | https://example.luware.com |
| vfcrest/v1/conversations/{ccdrid}/metadata | The initial endpoint to send the request. | Yes | vfcrest/v1/conversations/5399f478-aa0b-4834-b64f-211ecca0c74a/metadata |
| Headers | Description | Mandatory | Example |
| Ocp-Apim-Subscription-Key | Unique API subscription key for your customer environment. | Yes | 159b3228-f741-4e4a-88aa-ea70ad320783 |
| Authorization: Bearer | The access_token received from the v1/token/auth endpoint. | Yes | fL9QPL2U667bBpitMFhtNIn2kLHC15WB |
| URL Parameters | Description | Mandatory | Example |
| ccdrId | The unique identifier within Luware Recording for a specific captured conversation. The matching field in the web portal is Conversation Identifier. | Yes | 5399f478-aa0b-4834-b64f-211ecca0c74a |
| Body | Description | Mandatory | Example |
|
{ "metaTemplateId": 1234, "metaTemplateName": "Custom Metadata Template ", "metaTemplateType": "custom", "metadata": [ { "name": "service_line", "value": "{Imported metadata value}" }, { "name": "service_line_upn", "value": "{Imported metadata value}" } ] } |
Adds metadata from an external system into the Luware Recording environment, enabling extended search functionality.
Contact Luware Recording support for assistance on identifying the metadata template, identifiers and names. |
Yes |
{ "metaTemplateId": 1234, "metaTemplateName": "Custom Metadata Template ", "metaTemplateType": "custom", "metadata": [ { "name": "service_line", "value": "Test service line" }, { "name": "service_line_upn", "value": "testserviceupn@luware.com" } ] } |
Responses
| Code | Description |
| 200 |
Successful operation Example response: {
|
| 400 | Invalid request, check the required headers and parameters are included. |
| 401 | Invalid credentials, check header and parameter values are URL encoded. |
| 403 | Forbidden request, check headers and parameters are included. |
| 404 | Not found, recommend raising a support case. |
| 405 | Not allowed, recommend raising a support case. |
| 409 | Already exists, recommend raising a support case. |
| 500 | Internal server error, recommend raising a support case. |
| 502 | Bad gateway, recommend raising a support case. |
Retrieve expanded metadata for a recording
Request extended metadata including the transcript and summary using expands parameter.
GET vfcrest/v1/conversations/{ccdrid}
Request
| URI | Description | Mandatory | Example |
| GET | The method required for the API endpoint. | Yes | GET |
| <URI> | Luware will provide the relevant URI to send requests to during onboarding or via support channels. | Yes | https://example.luware.com |
| vfcrest/v1/conversations/{ccdrid} | The initial endpoint to send the request. | Yes | vfcrest/v1/conversations/5399f478-aa0b-4834-b64f-211ecca0c74a |
| Headers | Description | Mandatory | Example |
| Ocp-Apim-Subscription-Key | Unique API subscription key for your customer environment. | Yes | 159b3228-f741-4e4a-88aa-ea70ad320783 |
| Authorization: Bearer | The access_token received from the v1/token/auth endpoint. | Yes | fL9QPL2U667bBpitMFhtNIn2kLHC15WB |
| Parameters | Description | Mandatory | Example |
| ccdrId | The unique identifier within Luware Recording for a specific captured conversation. The matching field in the web portal is Conversation Identifier. | Yes | 5399f478-aa0b-4834-b64f-211ecca0c74a |
Using URL Parameters✅To use the below URL parameters, you must include a ? symbol prior to the below parameters, for example: vfcrest/v1/conversations/{ccdrid}?expands=METADATA | |||
| expands |
Pulls additional metadata, instant message transcripts or speech analytics data.
Options: METADATA IM TRANSCRIPT_DB SPEECH_SUMMARY |
No | expands=METADATA |
Responses
| Code | Description |
| 200 |
Successful operation Example response: {
|
| 400 | Invalid request, check the required headers and parameters are included. |
| 401 | Invalid credentials, check header and parameter values are URL encoded. |
| 403 | Forbidden request, check headers and parameters are included. |
| 404 | Not found, recommend raising a support case. |
| 405 | Not allowed, recommend raising a support case. |
| 409 | Already exists, recommend raising a support case. |
| 500 | Internal server error, recommend raising a support case. |
| 502 | Bad gateway, recommend raising a support case. |
Add a label to a conversation recording
Add a label to a unique conversation recording identifying it within the Luware Recording system. Policies can be setup based on specific labels to perform actions such as extending the retention period.
POST vfcrest/v1/conversations/{ccdrid}/labels
Request
| URI | Description | Mandatory | Example |
| POST | The method required for the API endpoint. | Yes | POST |
| <URI> | Luware will provide the relevant URI to send requests to during onboarding or via support channels. | Yes | https://example.luware.com |
| vfcrest/v1/conversations/{ccdrid} | The initial endpoint to send the request. | Yes | vfcrest/v1/conversations/5399f478-aa0b-4834-b64f-211ecca0c74a |
| Headers | Description | Mandatory | Example |
| Ocp-Apim-Subscription-Key | Unique API subscription key for your customer environment. | Yes | 159b3228-f741-4e4a-88aa-ea70ad320783 |
| Authorization: Bearer | The access_token received from the v1/token/auth endpoint. | Yes | fL9QPL2U667bBpitMFhtNIn2kLHC15WB |
| Parameters | Description | Mandatory | Example |
| ccdrId | The unique identifier within Luware Recording for a specific captured conversation. The matching field in the web portal is Conversation Identifier. | Yes | 5399f478-aa0b-4834-b64f-211ecca0c74a |
| Body | Description | Mandatory | Example |
|
{ "labelId": } |
Identifies the label that must be added to the conversation recording. LabelId can be found by navigating to Data, Manage Labels and pulling the label identifier. | No |
{ "labelId": 1 } |
Responses
| Code | Description |
| 200 |
Successful operation Example response: {
|
| 400 | Invalid request, check the required headers and parameters are included. |
| 401 | Invalid credentials, check header and parameter values are URL encoded. |
| 403 | Forbidden request, check headers and parameters are included. |
| 404 | Not found, recommend raising a support case. |
| 405 | Not allowed, recommend raising a support case. |
| 409 | Already exists, recommend raising a support case. |
| 500 | Internal server error, recommend raising a support case. |
| 502 | Bad gateway, recommend raising a support case. |
Perform Start and Stop actions on recordings
Perform start or stop actions for controlled recording or mark conversations to be kept if using on-demand recording.
POST vfcrest/v1/conversationControl/{ccdrid}/
Request
| URI | Description | Mandatory | Example |
| POST | The method required for the API endpoint. | Yes | POST |
| <URI> | Luware will provide the relevant URI to send requests to during onboarding or via support channels. | Yes | https://example.luware.com |
| vfcrest/v1/conversationControl/{ccdrid}/ | The initial endpoint to send the request. | Yes | vfcrest/v1/conversationControl/5399f478-aa0b-4834-b64f-211ecca0c74a/ |
| startRecording | Start recording the conversation record. Only applicable with users configured with Controlled or Controlled-AutoStart recording modes. | No | vfcrest/v1/conversationControl/5399f478-aa0b-4834-b64f-211ecca0c74a/startRecording |
| stopRecording | Stop recording the conversation record. Only applicable with users configured with Controlled or Controlled-AutoStart recording modes. | No | vfcrest/v1/conversationControl/5399f478-aa0b-4834-b64f-211ecca0c74a/stopRecording |
| keepOndemand | Save a recording stored in the On-Demand buffer. Only applicable with users configured with On-Demand recording mode. | No | vfcrest/v1/conversationControl/5399f478-aa0b-4834-b64f-211ecca0c74a/keepOndemand |
| Headers | Description | Mandatory | Example |
| Ocp-Apim-Subscription-Key | Unique API subscription key for your customer environment. | Yes | 159b3228-f741-4e4a-88aa-ea70ad320783 |
| Authorization: Bearer | The access_token received from the v1/token/auth endpoint. | Yes | fL9QPL2U667bBpitMFhtNIn2kLHC15WB |
| Parameters | Description | Mandatory | Example |
| ccdrId | The unique identifier within Luware Recording for a specific captured conversation. The matching field in the web portal is Conversation Identifier. | Yes | 5399f478-aa0b-4834-b64f-211ecca0c74a |
Responses
| Code | Description |
| 200 |
Successful operation Example response: {
|
| 400 | Invalid request, check the required headers and parameters are included. |
| 401 | Invalid credentials, check header and parameter values are URL encoded. |
| 403 | Forbidden request, check headers and parameters are included. |
| 404 | Not found, recommend raising a support case. |
| 405 | Not allowed, recommend raising a support case. |
| 409 | Already exists, recommend raising a support case. |
| 500 | Internal server error, recommend raising a support case. |
| 502 | Bad gateway, recommend raising a support case. |