Use Cases

• Programmatically download audio files to be imported into another system
• Programmatically generate links to play recorded calls outside of Chronicall
• To see an example, click here.

Obtaining Audio Files

GET /rest/api/v1/recordings/{recording-key}/audio?format={format}

An endpoint to download a single Recording.

Response

If a successful request is made, then the response will be a file containing the audio of the Recording in the specified file type.

GET /rest/api/v1/calls/{call-key}/audio?format={format}

An endpoint to download all of the Recordings on a call.

Response

If a successful request is made, then the response will be a file containing the audio of the call’s Recordings in the specified file type.

Potential Errors

Exporting Audio Files

POST /rest/api/v1/recordings/audio?format={format}

An endpoint to download all authorized recordings in a timeframe or a specified list of recordings, in the specified format spx (default) or wav. This requires a JSON request body.

{ 
      "startTime":"{startTime}",
      "endTime":"{endTime}"
     }

{ 
       "recordingKeys":[
         "{uuid}-{start}",
         "{uuid}-{start}",
         "{uuid}-{start}"
       ]
     }

Response

If a successful request is made, then the response will be a Zip File containing the audio of the recordings requested in the specified file type with a file containing details on each recording.

Potential Errors

POST /rest/api/v1/calls/audio?format={format}

An endpoint to download all authorized recordings from calls in a timeframe or a specified list of calls, in the specified format spx (default) or wav. This requires a JSON request body.

{ 
      "startTime":"{startTime}",
      "endTime":"{endTime}"
     }

{ 
       "callKeys":[
        "{uuid}-{start}-{end}",            
        "{uuid}-{start}-{end}",
        "{uuid}-{start}-{end}"
       ]
}

Response

If a successful request is made, then the response will be a Zip File containing the audio of the calls requested in the specified file type with a file containing details on each recording.

Potential Errors

Creating External Listen Links

POST /rest/api/v1/recordings/{recording-key}/external-listen-link

Obtain an External Listen Link for a specific Recording.

This requires that System Settings -> Basic Settings -> Externally Accessible Address in Chronicall be set with protocol (e.g. http://), domain (e.g., mywebsite.com or 10.0.0.101), and port (if applicable, e.g., :9080), for example: http://10.0.0.101:9080.

Response

If a successful request is made then a json result is returned. The External Listen Link that is generated will be valid forever (Integer.MAX_VALUE days).

{ 
   "listenLink":"http://www.my-chronicall.com/extlisten/recording/
   index.html?id\u003dc9ab20e0-9ad7-4eda-90be-cb401c39f981"
}

Potential Errors

POST /rest/api/v1/calls/{call-key}/external-listen-link

Obtain an External Listen Link for a specific call.

This requires that System Settings -> Basic Settings -> Externally Accessible Address in Chronicall be set with protocol (e.g., http://), domain (e.g., mywebsite.com or 10.0.0.101), and port (if applicable, e.g., :9080), for example: http://10.0.0.101:9080.

Response

If a successful request is made, then a json result is returned. The external listen link that is generated will be valid forever (Integer.MAX_VALUE days).

{ 
   "listenLink":"http://www.my-chronicall.com/extlisten/recording/
   index.html?id\u003dc9ab20e0-9ad7-4eda-90be-cb401c39f981"
}

Potential Errors

Obtaining Recording Data

GET /rest/api/v1/calls/{call-key}/recordings

An endpoint to obtain all of the recording records for a given call.

Response

If a successful request is made, then a json list of basic recording record data will be returned.

[ 
   { 
      "recordingKey":"83849370-5753-4186-9fc5-9c069e615734-1568735345298",
      "startTime":1568735345298,
      "duration":48974,
      "poolId":"d25839a1-2916-4825-8a36-299a1119f732",
      "size":42443,
      "eventId":50165,
      "recordingSystemId":1,
      "status":"SAVED"
   },
   { 
      "recordingKey":"0a72f610-8615-4ac9-8f1d-b914f9f164dc-1568739643644",
      "startTime":1568739643644,
      "duration":59347,
      "poolId":"308b6f52-1f61-4c4f-9ee4-543f37f3937f",
      "size":49743,
      "eventId":54035,
      "recordingSystemId":1,
      "status":"SAVED"
   }
]

Response

If a successful request is made, then a json list of basic recording record data will be returned. The result can be an empty list. Recordings for which the user does not have access will not be returned.

[ 
   { 
      "recordingKey":"83849370-5753-4186-9fc5-9c069e615734-1568735345298",
      "startTime":1568735345298,
      "duration":48974,
      "poolId":"d25839a1-2916-4825-8a36-299a1119f732",
      "size":42443,
      "eventId":50165,
      "recordingSystemId":1,
      "status":"SAVED"
   },
   { 
      "recordingKey":"0a72f610-8615-4ac9-8f1d-b914f9f164dc-1568739643644",
      "startTime":1568739643644,
      "duration":59347,
      "poolId":"308b6f52-1f61-4c4f-9ee4-543f37f3937f",
      "size":49743,
      "eventId":54035,
      "recordingSystemId":1,
      "status":"SAVED"
   }
]

Potential Errors