Command Line Interface

Voicent Auto Reminder provides command line support. You can create, delete, import, and get call status from the command line. The Auto Reminder program is called AptBook.exe, typically installed under "C:\Program Files\Voicent\AutoReminder\bin". You can invoke it from the command line by specify the full path:

"C:\Program Files\Voicent\AutoReminder\bin\AptBook.exe" ...

Import Appointments

Use the following command to import appointments:

"...\AptBook.exe" -import <import_file>

e.g.

"...\AptBook.exe" -import "C:\my tool\output\today.csv"

The <import_file> is the name of an import file. The format of the import file is specified in Import Appointments.

The import results are listed in the "cmdresult.txt" file located in the run directory. Each appointment created is identified by an appid, which is a relative path to the corresponding appointment file. The appids line in the cmdresult.txt file is a semicolon separated list of appids. If an appointment is not imported correctly, an empty appid is returned.

Create an appointment

Use the following command to create an appointment.

"...\AptBook.exe" -create <one_appointment>

The format of <one_appointment> is the same as a line in the import file. The result is saved in the cmdresult.txt file found in the run directory. If the appointment is successfully created, the corresponding appid is returned in the result file.

Delete appointments

Use the following command to delete appointments.

"...\AptBook.exe" -delete <appids>

The <appids> is a semicolon separated list of appids. If an appointment is deleted successfully, a "deleted" string will appear in the status line in the cmdresult.txt file. Otherwise, the string is empty.

Get appointment call status

Use the following command to get appointment call status.

"...\AptBook.exe" -status <appids>

The call status strings are: pending, retry, made, failed, mixed.

Get appointment call status info

Use the following command to get appointment call status info.

"...\AptBook.exe" -statusinfo <appids>

The call status strings are: pending, retry, made, failed, mixed.

Get appointment confirmation status

Use the following command to get appointment confirmation status.

"...\AptBook.exe" -confirmation <appids>

The confirmation status string are Confirmed, Confirmed (No), Maybe, Cancel, Reschedule, Message, and [Customized String].

Get appointment reminder call report

Use the following command to get appointment reminder call report.

"...\AptBook.exe" -callreport <appids>

The return is a comma separated table for the call report.