Endpoint APIs
Endpoints define where your recorded data is exported to (export Endpoints) and stored in (Storage Location Endpoints).
Export Endpoints
Endpoints define a location to export captured data to. Once a data Endpoint is configured, using either the Webhook or Real-time Stream (Socket) Export Channel, automated export policies can be set up to export stored or live data (media, metadata, transcriptions). Using these policies, you can define specific recordings to export to your defined Endpoints and trigger the export automatically, as needed.
Storage Location Endpoints
Communication Recording Agent uses cloud storage to store your captured data (audio, metadata, transcriptions). Storage locations can be defined to provide additional “hot, cool, or cold storage” facilities and flexible archiving options. Combined with the Policy Engine features, these provide an extensive archive and storage capability, automatically moving data between storage facilities for archive purposes.
For example, you may need to keep recent calls readily available for review, whereas older calls may only need to be kept for compliance purposes. Using automated storage policies, you can move your captured data from a "hot" storage location to a cheaper cool or cold storage location when the captured data matches a specific condition set in a storage policy filter.
See Policy Management APIs for further details on Export and Storage policies.
To change your default storage location, where your captured calls are initially saved, use the /v1/media/external-storages APIs. For detailed information on default storage APIs, click here.
This topic details the endpoints, request parameters, response parameters, and examples for the following requests to help you manage your Endpoints via API.
Note
The Communication Recording Agent APIs use the following resiliency behaviors to ensure that requests continue to work as expected even when unexpected parameters are present:
Any query parameters in addition to those documented in the API requests linked above (parameters unknown by the system) are ignored.
When requests contain duplicate parameters, the last instance of that duplicated parameter is used for the request; all other duplicates are ignored.
For more information on the above, including examples, see API Overview.