Recording Pause/Resume

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.

Note: For this feature, you must be updated to version 4.0.9 or newer.

Suggest Edits

Use Cases

Programmatically pause/unpause audio recording when an agent is accepting sensitive information (like a credit card number) over the phone.

Obtaining Agent Mapping

GET /rest/api/v1/agents/mapping

An endpoint to get the agent mappings.

Response

If a successful request is made, then a json result is returned.

{ 
  "nthatcher": "Nate Thatcher(123)",
   ...
}

Potential Errors

Status Code	Failure
401 Unauthorized	The *authorization header* wasn't valid.
403 Forbidden	The authenticated user doesn't have Chronicall access to the mapping.

Managing Active Recording for an Agent

GET /rest/api/v1/agents/{AgentId}/active-recording

An endpoint to get the active recording state for an agent.

Arguments
AgentId	The *AgentId* of the desired agent.

Response

If a successful request is made then a json result is returned. Possible values for state are NO_RECORDING, RECORDING, and PAUSED.

{ 
  "state": "RECORDING"
}

Potential Errors

Status Code	Failure
401 Unauthorized	The *authorization header* wasn't valid.
403 Forbidden	The authenticated user doesn't have Chronicall access to the mapping.
404 Not Found	There is no agent found for the given *AgentId*.

POST /rest/api/v1/agents/{AgentId}/active-recording/pause

An endpoint to pause the active recording of an agent.

Arguments
AgentId	The *AgentId* of the desired agent.

Response

If a successful request is made then a json result is returned. Possible values for state are NO_RECORDING, RECORDING, and PAUSED.

{ 
  "state": "PAUSED"
}

Potential Errors

Status Code	Failure
401 Unauthorized	The *authorization header* wasn't valid.
403 Forbidden	The authenticated user doesn't have Chronicall access to the mapping.
404 Not Found	There is no agent found for the *AgentId*.

POST /rest/api/v1/agents/{AgentId}/active-recording/resume

An endpoint to resume the active recording of an agent.

Arguments
AgentId	The *AgentId* of the desired agent.

Response

If a successful request is made, then a json result is returned. This result indicates the new state for the active recording for the agent. Possible values for state are NO_RECORDING, RECORDING, and PAUSED.

{ 
  "state": "RECORDING"
}

Potential Errors

Status Code	Failure
401 Unauthorized	The *authorization header* wasn't valid.
403 Forbidden	The authenticated user doesn't have Chronicall access to the mapping.
404 Not Found	There is no agent found for the given *AgentId*.

Updated over 5 years ago