This guide details how to configure Vonage Contact Center (VCC) permissions to control access to interaction content through the API.
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Configurable permissions
Info | ||
---|---|---|
| ||
|
...
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 |
|
...
Content type name as returned by ICS API | endpoint | operation | Required permissions (user requires all permissions unless otherwise specified) |
---|---|---|---|
callRecording videoRecording | 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 |
|
...
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 |
|
...