Obtaining a Recording/Call Key Example

In this example, we'll test getting recording data including recording/call key.

Create a Service User

Within Chronicall, create a new Service User. This will provide us with an authentication key.

  • Create a new user in User Management > User Accounts.
  • Click the User drop-down menu and select .
  • Enter a name in the Name field and select the "Service User" option at the bottom.
  • Save your changes.

Once completed, you will find the authentication key within API Enablement > Service Users.


Configure Agent for Recording

Within Chronicall, we will configure and agent to record their calls.

  • Start by going to Recording > Manage Recording Rules.
  • You may have to click "Add" to bring you to a new rule configuration shown below.
  • Give your rule a title; we will use "test".
  • Add agents you want to have recorded using this rule.
  • Click OK.

Once you have configured the recording rule, you must call one of the agents you selected in your rule configuration. If you do not call, there will be no recorded messages to query.


Download Postman

Download and install the Postman application at the Postman Site.

Configure a Query

Launch Postman.

Create a new Request.

  • We'll name the Request "Recording Data Demonstration".
  • You may also need to create a "Collection." We'll call ours "Sample Collection".

Now that we have a request, we will first update the URL query.

  • Change the API type to "GET".
  • Replace the request URL with http://localhost:9080/rest/api/v1/recordings?startTime={startTime}&endTime={endTime}

For our example, startTime= 0 and endTime= current time in milliseconds.


Next we will configure the authorization token.

  • Within Postman, click the Authorization tab.
  • Set the Type to Bearer Token.
  • Copy the Service User Authentication Key, which is found in API Enablement > Service Users, and paste it here.

We are now ready to test our query.

  • Make a call to the agent we configured for recording, answer, and then hang up. This is so that there is a call that can be retrieved.
  • Click on Send within Postman. You will see the resulting response below in the Response field.