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=
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
| Operator | Examples | Notes |
|---|---|---|
| equals |
param=equals:2018-11-01T00:00:00Z param=2018-11-01T00:00:00Z |
The operator name can be omitted, as it is the default operator |
| before | param=before:2018-10-10T13:05:34Z | |
| after | param=after:2018-11-05T09:12:24Z | |
| between | param=between:2018-11-01T00:00:00Z;2018-11-02T00:00:00Z | The lower limit is included and the upper one is not. The two limits are separated by a semicolon symbol |
String
Note: If the searched string contains a semicolon or a backslash, they must be escaped by prepending a backslash character.
| Operator | Examples | Notes |
|---|---|---|
| equals |
param=equals:some string param=semi\;colon and back\\slash |
The operator name can be omitted, as it is the default operator |
| contains | param=contains:some string |
|
||
| Prev | Next | |
| Product Integration API | Start Recording |