Overview

This section describes the REST API that can be used to integrate Call Recording and third party systems.

Basic Authentication

The REST API identifies its user with HTTP Basic Authentication. That is, if a function requires authentication, then it requires the Authorization HTTP header, which must be as follows:

Authorization: Basic <userPasswordBase64>

where <userPasswordBase64> is the base64 encoding of <user>:<password>.

For instance, suppose you need to call a function with user="myuser" and password="mypassword". You need to base64-encode the string "myuser:mypassword", which is "bXl1c2VyOm15cGFzc3dvcmQ=", obtaining the following HTTP header:

Authorization: Basic bXl1c2VyOm15cGFzc3dvcmQ=

Basic Authentication with SSO support

Starting from Imagicle 204.Spring.1 release, Imagicle REST APIs can be invoked by a user with SSO authentication. To enable this feature, the following setting file must be amended:

\StonevoiceAS\Apps\ApplicationSuite\Settings\ApplicationSuite.defaults

Locate the parameter "AllowBasicAuthForSsoUsersViaWebApi" and change its default value from 0 to 1 ⇒ AllowBasicAuthForSsoUsersViaWebApi=1

UCX Cloud Suite customers can contact Imagicle Support to enable this feature in their Cloud instance.

RHS Colon Syntax

Some of the API functions support RHS colon syntax to specify different parameter operators depending on the type of each parameter. The available operators syntax is listed below:

DateTime ISO-8601

String

Note: If the searched string contains a semicolon or a backslash, they must be escaped by prepending a backslash character.