RESTful Configuration Interface (RCI)

This interface provides access to configuration data and enables restricted configuring of users, user groups, queues, queue groups roles, skills, time zones, and presence profiles.

/users

Resource Request method

Object: required rights

/users

GET

User: View

POST

User: Create

/users/{userId}

GET

User: View

PUT

User: Modify

DELETE

User: View and Delete

/users/{userId}/userGroups

GET

  • User: View

  • User group: View

POST

  • User: View

  • User group: View and Manage members

/users/{userId}/userGroups/{userGroupId}

GET

  • User: View

  • User group: View

DELETE

  • User: View

  • User group: View and Delete

/users/{userId}/roles

GET

  • User: View

  • User role: View

POST

  • User: View

  • User role: Manage members

/users/{userId}/roles/{roleId}

GET

User role: View

DELETE

  • User: View

  • User role: Manage members

/users/{userId}/certificates

GET

  • User: View

  • Certificate authentication info (selected automatically when the user right is given): View

POST

  • User: Modify

  • Certificate authentication info (selected automatically when the user right is given): Modify

/users/{userId}/certificates/{certificateId}

GET

  • User: View

  • Certificate authentication info (selected automatically when the user right is given): View

DELETE

  • User: Modify

  • Certificate authentication info (selected automatically when the user right is given): Modify

/users/{userId}/skills

GET

User: View

POST

User: Modify

/users/{userId}/skills/{skillId}

GET

User: View

PUT

User: Modify

DELETE

User: Modify

/users/{userId}/settings

/users/{userId}/attributes

 GET

User: View
POST

User: Modify

/userGroups

Resource Request method Object: required rights

/userGroups

GET

User group:

  • View

  • Manage members

POST

User group:

  • Create

  • Manage rights

  • Manage members

/userGroups/{userGroupId}

GET

User group:

  • View

  • Manage members

PUT

User group:

  • Modify

  • Manage members

DELETE

 User group:

  • View

  • Delete

/userGroups/{userGroupId}/users

GET

  • User: View

  • User group: View and Manage members

POST

  • User: View

  • User group: View and Manage members

/userGroups/{userGroupId}/users/{userId}

GET

  • User: View

  • User group: View and Manage members

DELETE

  • User: View

  • User group: View and Manage members

/userSettingsTemplates

Resource Request method Object: required rights

/userSettingsTemplates

GET

User settings template: View

POST

User settings template: Create

/userSettingsTemplates/{userSettingsTemplateId}

GET

User settings template: View

PUT

User settings template: Modify

DELETE

User settings template: Delete

/userSettingsTemplates/{userSettingsTemplateId}/settings

GET

User settings template: View

POST

User settings template: Modify

/queues

Resource Request method Object: required rights

/queues

GET

Queue: View

POST

Queue: Create

/queues/{queueId}

GET

Queue: View

PUT

Queue: Modify

DELETE

Queue:

  • View

  • Delete

/queues/{queueId}/extensions

GET

  • Queue: View

  • Queue's extension: View

POST

Extension: Create

/queues/{queueId}/extensions/{extensionId}

GET

  • Queue:View

  • Extension: View

PUT

  • Queue:Modify

  • Extension: Modify

DELETE

  • Queue:Modify

  • Extension: Delete

/queues/{queueId}/queueGroups

GET

  • Queue:View

  • Queue group: View

POST

  • Queue: View

  • Queue group: View and Manage members

/queues/{queueId}/queueGroups/{queueGroupId}

GET

  • Queue:View

  • Queue group: View

DELETE

  • Queue:View

  • Queue group: View and Manage members

/queues/{queueId}/attributes

GET

 Queue: View

POST

 Queue: Modify

/queueGroups

Resource Request method Object: required rights

/queueGroups

GET

Queue qroup: View

POST

Queue group: Create

/queueGroups/{queueGroupId}

GET

Queue group: View

PUT

Queue group: Modify

DELETE

Queue group:

  • View

  • Delete

/queueGroups/{queueGroupId}/queues

GET

  • Queue: View

  • Queue group: View

POST

  • Queue: View

  • Queue group: View and Manage members

/queueGroups/{queueGroupId}/queues/{queueId}

GET

  • Queue: View

  • Queue group: View

DELETE

  • Queue: View

  • Queue group: View and Manage members

/queueGroups/{queueGroupId}/attributes

GET

Queue group: View

POST

  • Queue: Modify

  • Queue group: Modify

/roles

Resource Request method Object: required rights

/roles

GET

User role: View

POST

User role: Create

/roles/{roleId}

GET

User role: View

PUT

User role: Modify

DELETE

User role: Delete

/roles/{roleId}/users

GET

  • User role: View

  • User: View

POST

  • User role: View and Manage members

  • User: View

/roles/{roleId}/users/{userId}

GET

User: View

DELETE

User role: View and Manage members

/skills

Resource Request method Object: required rights

/skills

GET

Skill: View

POST

Skill: Create

/skills/{skillId}

GET

Skill: View

PUT

Skill: Modify

DELETE

Skill: Delete

/scripts

Resource Request method Object: required rights

/scripts

GET

  • Script: View

  • Queue: View

/scripts/{scriptId}

GET

Script: View

/timeZones

Resource Request method Object: required rights

/timeZones

GET

No separate rights needed

/timeZones/{timeZoneId}

/prsProfiles

Resource Request method Object: required rights

/prsProfiles

GET

Presence profile: View

/prsProfiles/{prsProfileId}

/messagingServices

Resource Request method Object: required rights

/messagingServices

GET

Messaging service: View

POST

Messaging service: Create

/messagingServices/{messagingServiceId}

GET

Messaging service: View

PUT

Messaging service: Modify

DELETE

Messaging service: Delete

/messagingServices/{messagingServiceId}/authentications

GET

Messaging service: View

POST

Messaging service: Modify

/messagingServices/{messagingServiceId}/authentications/{id}

GET

Messaging service: View

PUT

Messaging service: Modify

DELETE

/replyTemplates

Resource Request method Object: required rights

/replyTemplates

GET

Queue: View

/replyTemplates/{replyTemplateId}

/replyTemplates/{replyTemplateId}/attachments

  • Queue: View

  • Reply template folder (where the reply template with attachments is stored): View

/replyTemplates/{replyTemplateId}/attachments/{attachmentId}

  • Queue: View

  • Reply template folder (where the reply template with attachments is stored): View

/customIvrs

Resource Request method Object: required rights

/customIvrs

GET

Custom IVRs: View

/customIvrs/{customIvrId}

/customIvrs/{customIvrId}/sourceCodes

/customIvrs/{customIvrId}/sourceCodes/{sourceCodeId}

/customIvrs/{customIvrId}/currentSourceCodeVersion

/customIvrs/{customIvrId}/attributes

POST

Custom IVRs: Modify

/customIvrs/{customIvrId}/parameters

GET

Custom IVRs: View

POST

Custom IVRs: Modify

/audioPrompts

Resource Request method Object: required rights

/audioPrompts

GET

Audio prompts: View

/audioPrompts/{audioPromptId}

/cpExtensions

Resource Request method Object: required rights

/cpExtensions

GET

Third-party extensions: View

/cpExtensions/{cpExtensionId}

/disruptionSets

Resource Request method Object: required rights

/disruptionSets

GET

Disruption set: View

/disruptionSets/{disruptionSetId}

/disruptionSets/{disruptionSetId}/events

GET

  • Disruption set: View

  • Disruption event: View

POST

  • Disruption set: Modify

  • Disruption event: Create

/disruptionSets/{disruptionSetId}/events/{eventId}

GET

  • Disruption set: View

  • Disruption event: View

PUT

  • Disruption set: Modify

  • Disruption event: Modify

DELETE

  • Disruption set: View

  • Disruption event: Delete

/disruptionSets/{disruptionSetId}/events/bulk

DELETE

  • Disruption set: Delete

  • Disruption event: Delete

/disruptionSets/{disruptionSetId}/items

/disruptionSets/{disruptionSetId}/items/{itemId}

GET

  • Disruption set: View

  • Disruption item: View

/jobs

Resource Request method Object: required rights

/jobs

GET

Import/Export job: View

/jobs/{jobId}

DELETE

Import/Export job: Delete

/import

Resource Request method Object: required rights

/import/calendar

/import/campaign

/import/configuration

/import/consents

/import/directory

/import/disruptionItems

/import/outboundBlockedNumbers

/import/presenceProfiles

/import/queues

/import/rights

/import/roles

/import/scripts

/import/skills

/import/userGroupHierarchy

/import/users

POST

  • Import/Export job: Modify or Create

  • Rights to the objects you are importing

    Example:

    If you are creating a campaign, you need rights to create campaigns. You also need rights to create or modify customers.

    With the copyFromId and copyFromName options, you need also rights to view the campaign from which you are copying.

/emergencyLocations

Resource Request method Object: required rights

/emergencyLocations

GET

Role: Superuser or Emergency admin

POST

/emergencyLocations/{emergencyLocationId}

GET

DELETE

/userEmergencyLocations

Resource Request method Object: required rights

/userEmergencyLocations

GET

Role: Emergency user

POST

/userEmergencyLocations/{userEmergencyLocationId}

GET

DELETE

/callSwitchingLocations

Resource Request method Object: required rights

/callSwitchingLocations

GET

Location: View

/callSwitchingLocations/{callSwitchingLocationId}

/secrets

Resource Request method Object: required rights

/secrets

GET

Secret: View

POST

Secret: Create

/secrets/{secretId}

GET

Secret: View

PUT

Secret: Modify

DELETE

Secret: Delete

/templateCompany

For customized use only