Configuring permissions for accessing interaction content
- Helen Griffith
Owned by Helen Griffith
This guide details how to configure Vonage Contact Center (VCC) permissions to control access to interaction content through the API.
In this page
Configurable permissions
Extra information
- Bearer tokens generated using VCC API client credentials reflect permissions of the user who requested the client credentials.
- In addition to permissions described in this guide, specific scopes are also required depending on the endpoint being used. For information about required scopes, see Authentication (Interaction Content API).
Configured feature permissions determine the level of access users have to interaction content. For information about configuring feature permissions, see /wiki/spaces/PD/pages/3784966287.
Access to interaction content is configured within the following sections:
Interaction Content
| Feature | Permission levels |
|---|---|
| Access groups of users' content (overrides line permissions) | Yes | No |
| Add call recording comments | Yes | No |
| Delete call recording comments | Yes | No |
| Delete interaction content | Yes | No |
| View inbound interaction content | Yes | No |
| View outbound interaction content | Yes | No |
| View screen recordings | Yes | No |
View collected IVR data within Interaction Plans
| Feature | Permission levels |
|---|---|
| View collected IVR data | Yes | No |
In addition, agents can access their own call recordings or all call recordings. This access is set at account level. Contact your account manager to turn these on.
How operations are affected by a user's configured permissions
General
- Search for interactions. The user must have permission to at least one content type for the endpoint to return an interaction's metadata.
- Delete specific interaction and its content by its GUID. The endpoint requires the user to have access to all content linked to an interaction to delete it.
- Get specific interaction by its GUID. The user must have permission to at least one content type for the endpoint to return an interaction's metadata. The endpoint will return content metadata for only the content the user has permission to.
Examples
Supervisor user with Access groups of users content (overrides line permissions) set to Yes
| Content type name as returned by ICS API | Endpoint | operation | Required permissions |
|---|---|---|---|
callRecording | GET /interactions | Search for interactions |
|
| GET /interactions/{guid} | Get specific interaction by its GUID |
| |
| DELETE /interactions/{guid} | Delete specific interaction and all linked content by its GUID |
| |
| POST /interactions/delete-batch | Delete up to 1000 interactions | Same checks as for Delete specific interaction and all linked content by its GUID are performed for each interaction. Some interactions will be deleted, and some will not — depends on each interaction's required permissions check results. | |
| DELETE /interactions/{guid}/content/{contentKey} | Delete single interaction content file |
| |
| GET /interactions/{guid}/content/{contentKey} | Get single interaction content file |
| |
screenRecording | GET /interactions | Search for interactions |
|
| GET /interactions/{guid} | Get specific interaction by its GUID |
| |
| DELETE /interactions/{guid} | Delete specific interaction and its content by its GUID |
| |
| POST /interactions/delete-batch | Delete up to 1000 interactions | Same checks as for Delete specific interaction and its content by its GUID are performed for each interaction. Some interactions will be deleted, and some will not — depends on each interaction's required permissions check results. | |
| DELETE /interactions/{guid}/content/{contentKey} | Delete single interaction content file |
| |
| GET /interactions/{guid}/content/{contentKey} | Get single interaction content file |
| |
voicemail (when this user is recipient of voicemail) | GET /interactions | Search for interactions |
|
| GET /interactions/{guid} | Get specific interaction by its GUID | Allowed regardless of permissions | |
| DELETE /interactions/{guid} | Delete specific interaction and its content by its GUID |
| |
| POST /interactions/delete-batch | Delete up to 1000 interactions | Same checks as for Delete specific interaction and its content by its GUID are performed for each interaction. Some interactions will be deleted, and some will not — depends on each interaction's required permissions check results. | |
| DELETE /interactions/{guid}/content/{contentKey} | Delete single interaction content file | Allowed regardless of permissions | |
| GET /interactions/{guid}/content/{contentKey} | Get single interaction content file | Allowed regardless of permissions | |
| ivrAudioRecording | GET /interactions | Search for interactions |
|
| GET /interactions/{guid} | Get specific interaction by its GUID |
| |
| DELETE /interactions/{guid} | Delete specific interaction and its content by its GUID |
| |
| POST /interactions/delete-batch | Delete up to 1000 interactions | Same checks as for Delete specific interaction and its content by its GUID are performed for each interaction. Some interactions will be deleted, and some will not — depends on each interaction's required permissions check results. | |
| DELETE /interactions/{guid}/content/{contentKey} | Delete single interaction content file |
| |
| GET /interactions/{guid}/content/{contentKey} | Get single interaction content file |
|
Supervisor user with Access groups of users' content (overrides line permissions) set to No
| Content type name as returned by ICS API | endpoint | operation | Required permissions (user requires all permissions unless otherwise specified) |
|---|---|---|---|
callRecording | GET /interactions | Search for interactions |
|
| GET /interactions/{guid} | Get specific interaction by its GUID |
| |
| DELETE /interactions/{guid} | Delete specific interaction and its content by its GUID |
| |
| POST /interactions/delete-batch | Delete up to 1000 interactions | Same checks as for Delete specific interaction and its content by its GUID are performed for each interaction. Some interactions will be deleted, and some will not — depending on each interaction's required permissions check results. | |
| DELETE /interactions/{guid}/content/{contentKey} | Delete single interaction content file |
| |
| GET /interactions/{guid}/content/{contentKey} | Get single interaction content file |
| |
screenRecording | GET /interactions | Search for interactions |
|
| GET /interactions/{guid} | Get specific interaction by its GUID |
| |
| DELETE /interactions/{guid} | Delete specific interaction and its content by its GUID |
| |
| POST /interactions/delete-batch | Delete up to 1000 interactions | Same checks as for Delete specific interaction and its content by its GUID are performed for each interaction. Some interactions will be deleted, and some will not — depending on each interaction's required permissions check results. | |
| DELETE /interactions/{guid}/content/{contentKey} | Delete single interaction content file |
| |
| GET /interactions/{guid}/content/{contentKey} | Get single interaction content file |
| |
voicemail (when this user is recipient of voicemail) | GET /interactions | Search for interactions |
|
| GET /interactions/{guid} | Get specific interaction by its GUID | Allowed regardless of permissions | |
| DELETE /interactions/{guid} | Delete specific interaction and its content by its GUID |
| |
| POST /interactions/delete-batch | Delete up to 1000 interactions | Same checks as for Delete specific interaction and its content by its GUID are performed for each interaction. Some interactions will be deleted, and some will not — depending on each interaction's required permissions check results. | |
| DELETE /interactions/{guid}/content/{contentKey} | Delete single interaction content file | Allowed regardless of permissions | |
| GET /interactions/{guid}/content/{contentKey} | Get single interaction content file | Allowed regardless of permissions | |
| ivrAudioRecording | GET /interactions | Search for interactions |
|
| GET /interactions/{guid} | Get specific interaction by its GUID |
| |
| DELETE /interactions/{guid} | Delete specific interaction and its content by its GUID |
| |
| POST /interactions/delete-batch | Delete up to 1000 interactions | Same checks as for Delete specific interaction and its content by its GUID are performed for each interaction. Some interactions will be deleted, and some will not — depending on each interaction's required permissions check results. | |
| DELETE /interactions/{guid}/content/{contentKey} | Delete single interaction content file |
| |
| GET /interactions/{guid}/content/{contentKey} | Get single interaction content file |
|
Admin user
| Content type name as returned by ICS API | endpoint | operation | Required permissions (user requires all permissions unless otherwise specified) |
|---|---|---|---|
callRecording | GET /interactions | Search for interactions |
|
| GET /interactions/{guid} | Get specific interaction by its GUID |
| |
| DELETE /interactions/{guid} | Delete specific interaction and its content by its GUID |
| |
| POST /interactions/delete-batch | Delete up to 1000 interactions | Same checks as for Delete specific interaction and its content by its GUID are performed for each interaction. Some interactions will be deleted, and some will not — depending on each interaction's required permissions check results. | |
| DELETE /interactions/{guid}/content/{contentKey} | Delete single interaction content file |
| |
| GET /interactions/{guid}/content/{contentKey} | Get single interaction content file |
| |
screenRecording | GET /interactions | Search for interactions |
|
| GET /interactions/{guid} | Get specific interaction by its GUID |
| |
| DELETE /interactions/{guid} | Delete specific interaction and its content by its GUID |
| |
| POST /interactions/delete-batch | Delete up to 1000 interactions | Same checks as for Delete specific interaction and its content by its GUID are performed for each interaction. Some interactions will be deleted, and some will not — depending on each interaction's required permissions check results. | |
| DELETE /interactions/{guid}/content/{contentKey} | Delete single interaction content file |
| |
| GET /interactions/{guid}/content/{contentKey} | Get single interaction content file |
| |
voicemail (when this user is recipient of voicemail) | GET /interactions | Search for interactions |
|
| GET /interactions/{guid} | Get specific interaction by its GUID | Allowed regardless of permissions | |
| DELETE /interactions/{guid} | Delete specific interaction and its content by its GUID |
| |
| POST /interactions/delete-batch | Delete up to 1000 interactions | Same checks as for Delete specific interaction and its content by its GUID are performed for each interaction. Some interactions will be deleted, and some will not — depending on each interaction's required permissions check results. | |
| DELETE /interactions/{guid}/content/{contentKey} | Delete single interaction content file | Allowed regardless of permissions | |
| GET /interactions/{guid}/content/{contentKey} | Get single interaction content file | Allowed regardless of permissions | |
| ivrAudioRecording | GET /interactions | Search for interactions |
|
| GET /interactions/{guid} | Get specific interaction by its GUID |
| |
| DELETE /interactions/{guid} | Delete specific interaction and its content by its GUID |
| |
| POST /interactions/delete-batch | Delete up to 1000 interactions | Same checks as for Delete specific interaction and its content by its GUID are performed for each interaction. Some interactions will be deleted, and some will not — depending on each interaction's required permissions check results. | |
| DELETE /interactions/{guid}/content/{contentKey} | Delete single interaction content file |
| |
| GET /interactions/{guid}/content/{contentKey} | Get single interaction content file |
|