How Do I Use The Command Line To Export Recordings?

NOTE: This feature has been replaced by our Recording Data API on newer versions of Chronicall/ACR, versions 4.X and above

Question

The ability to export recordings from Chronicall/ACR has been around since 3.8, but recently a new option was added to the software. Mainly, the ability to export the recordings from a command-line interface, which allows for easier automation. How do I do this?

 

Answer

Using a curl or wget command from the command-line interface will allow you to pull the recordings you need.

NOTE: This article is provided by Xima Software as an outline to help you get started. If you have issues getting curl commands to run on your system please contact your System Administrator for support.

 

Windows Steps

  1. Navigate to the Chronicall/ACR server
  2. Open a Command Prompt window with admin privileges
  3. Navigate to the Downloads folder of the server
    • E.g. 
      • cd C:\Users\{Windows Username}\Downloads
  4. Create a curl command based on the following example: 
    • curl "http://localhost:9080/recording-export-tool?download&start=2021-09-13&end=2021-09-13&format=SPX&&token=243nGuTCcbDh48C" --output "export_test_2.zip"
    • NOTE: As long as you are running the command from the Chronicall/ACR server itself, the first part of the command will remain the same
  5. Once you hit the first ampersand (&) you can edit the URL to fit your query
    1. Changing the start and end sections will allow you to adjust what day(s) worth of recordings you wish to download
      • E.g.
        • Changing start=2021-09-13&end=2021-09-13 to start=2021-09-14&end=2021-09-15 will download recordings for the 14th and 15th of September, instead of the 13th.
    2. Changing the format section will allow you to change between downloading spx files or wav files
      • E.g.
        • format=SPX will download spx files
        • format=WAV will download wav files
    3. The token section can be changed within Chronicall/ACR to whatever you want but the default is this alphanumeric set
      • E.g. 
        • token=243nGuTCcbDh48C
    4. Lastly, you can change the name of the output file to whatever name you want, but be sure to end it with .zip
      • E.g.
        • --output "export_test_2.zip" will create a ZIP file called export_test_2
  6. NOTE: Please ensure that the entire URL is contained within quotations
    • E.g. 
      • "http://localhost:9080/recording-export-tool?download&start=2021-09-13&end=2021-09-13&format=SPX&&token=243nGuTCcbDh48C"
  7. Run the full curl command and a new zip folder will be created containing your recordings and a metadata.csv file

Linux Steps

  1. Open a PuTTy session with admin privileges to the Chronicall/ACR server
  2. Navigate to the Downloads folder of the server
    • E.g. 
      • cd /home/{Linux Username}/Downloads
  3. Create a curl command based on the following example: 
    • curl "http://localhost:9080/recording-export-tool?download&start=2021-09-13&end=2021-09-13&format=SPX&&token=243nGuTCcbDh48C" --output "export_test_2.zip"
    • NOTE: As long as you are running the command from the Chronicall/ACR server itself, the first part of the command will remain the same
  4. Once you hit the first ampersand (&) you can edit the URL to fit your query
    1. Changing the start and end sections will allow you to adjust what day(s) worth of recordings you wish to download
      • E.g.
        • Changing start=2021-09-13&end=2021-09-13 to start=2021-09-14&end=2021-09-15 will download recordings for the 14th and 15th of September, instead of the 13th.
    2. Changing the format section will allow you to change between downloading spx files or wav files
      • E.g.
        • format=SPX will download spx files
        • format=WAV will download wav files
    3. The token section can be changed within Chronicall/ACR to whatever you want but the default is this alphanumeric set
      • E.g. 
        • token=243nGuTCcbDh48C
    4. Lastly, you can change the name of the output file to whatever name you want, but be sure to end it with .zip
      • E.g.
        • --output "export_test_2.zip" will create a ZIP file called export_test_2
  5. NOTE: Please ensure that the entire URL is contained within quotations
    • E.g. 
      • "http://localhost:9080/recording-export-tool?download&start=2021-09-13&end=2021-09-13&format=SPX&&token=243nGuTCcbDh48C"
  6. Run the full curl command and a new zip folder will be created containing your recordings and a metadata.csv file
Was this article helpful?
0 out of 1 found this helpful

Table of Contents

    Environment

    Operating System

    PBX System

    Chronicall Version