Voiso supports two different types of authentication keys for API requests - the contact center API key and the user API key. API keys must be added to the request path or body parameters. This article outlines the distinction between keys and guides for acquiring them for authentication.
Consider that the 'contact center key', also known as client_api_key, is used across the entire contact center and is not tied to a specific user. This enables trusted integrations, where an external system can utilize the functions of the Voiso contact center without limitations.
At the same time, the 'user key', also known as user_api_key, is an attribute of a specific user configured within the contact center. The 'user key' inherits the same permissions and restrictions set up for the user. This key allows for more flexible integrations with different access levels to contact center data and features.
In most cases, as well as for integration debugging purposes, we recommend using the 'user key' of a user with administrator permissions.
Tip: Review the individual API overview articles and API endpoint descriptions, noting which key is needed and where it belongs in the request.
You can request the client (contact center) API key client_api_key from a Voiso account manager.
Important: Keep your contact center API key secret. If someone obtains it, they may try to make calls on behalf of your organization's account.
For strict authorization requirements, some APIs require a User Key. To access resources, the user represented by the user key must have access privileges to those resources. Refer to Security Access Groups.
A user_api_key is obtained in the Voiso application.
user_api_key is in the API Key field. Copy this value and paste it into your API query.