Policy Management APIs
Version 1.1
Use policy management APIs to manage Policies in your Communication Recording Agent system. Communication Recording Agent Policies allow you to perform automated actions against your captured conversation data, including recording control, retention and archiving, transcription, export, access control, and locks. These are all designed to help with your regulatory, data retention, and management requirements.
To better understand the types of policies, what they do, and how they work, see Policy Engine and Summary - APIs.
Get Policies
Get Policies by Endpoint ID (applicable to export and storage policies only)
Get the Claims Map for a Policy, Get Users, and Get Organization Groups (applicable to access policies only)
Create Policies:
Update Policies:
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.
New in this Article
Version 1.1 of this API Reference includes the following general updates:
This topic now includes Schedule-related requests and changes to the Storage Policy requests. 2025.2.3 introduces Schedules to determine when storage policies are applied. These Schedules can be managed using the Policy API.