Chronicall

I am John Doe

And I'm a Photographer

Page Content..

Glossary

This provides a list of all necessary API terminology and their definitions.

Authentication

After creating a Service User within the Chronicall UI, you will be given an authentication key.
Anytime a request is made to the API, an authentication key must be present.

Add the following header to your API request:

 Authorization : Bearer {authentication_key}

By having the authorization key present, you will be able to access everything that the Service User is set up in Chronicall to have access to.

Recording Status

Possible recording statuses:

  • PENDING - An event met a recording rule and should have a recording. Usually this means that the recording hasn’t finished processing yet.
  • SAVED - The recording is saved to an event on a call.
  • DELETED_USER - The recording was manually deleted by a user.
  • DELETED_SPACE - The recording was deleted by the Recording Library because the Recording Library was low on space.
  • DELETED_TIME - The recording was deleted by the Recording Library based on the Recording Library’s time retention policy.
  • DELETED_UNKNOWN - The recording was saved, but was manually deleted from the filesystem.
  • PENDING_DELETE_SPACE - The recording is flagged to be deleted later because of the Recording Library’s low space.
  • PENDING_DELETE_TIME - The recording is flagged to be deleted later because of the Recording Library’s retention policy.

Recording Key

The database key for a recording.
Example: 89e08e9f-a2aa-4059-9f93-1f53e3719431-1568754442049
Format: {recording-UUID}-{startTime}.

  • {recording-UUID}: The recording’s UUID, e.g., “89e08e9f-a2aa-4059-9f93-1f53e3719431”
  • {startTime}: Start of the recording in epoch millis.

Call Key

The database key for a call.
Format: {call-UUID}-{callStartTime}-{callEndTime}.

  • {call-UUID}: The call’s UUID, e.g., “89e08e9f-a2aa-4059-9f93-1f53e3719431”
  • {callStartTime}: Start of the call in epoch millis.
  • {callEndTime}: End of the call in epoch millis.

AgentId

Agent Identifier. Valid identifiers:

  • The agent extension. Example: "203"
  • The agent name and extension. Example: "Nate Thatcher(203)"
  • User defined alias.
    • There will be a setting in Avaya Call Reporting to define the mapping from alias to user. This alias is a custom string entered by the user.

Updated 2 months ago

Glossary


This provides a list of all necessary API terminology and their definitions.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.