Voicent AutoReminder Integration -
Open Web Access
The best way to interface with Voicent AutoReminder is through the
HTTP protocol. You can create, delete, and list appointments all
through this interface. The browser interface provided can be used as
a sample for your application.
Enable Web Access
To enable web access, select View > Setup
Client Server from the program main menu. Choose "allow web access". You need to have enterprise edition if you want to access it from a remote computer. For testing, you can use the browser on the same computer.
Click here to find more information about
password protected access.
(Release 4 and earlier) To enable web access, select the "allow web access" and set the
port number in the Customize View Dialog.
Once enable, you can access Voicent AutoReminder using any
browser.
Add Appointment Programmatically
AutoReminder supports the Browser Interface through its HTTP
interface. Since HTTP protocol is independent of programming
languages, you should be able to interface with AutoReminder using
any programming language. Most programming languages provide HTTP
client library (usually free), which makes it trivial to submit
parameters to a URL. The Gateway
Simple Call Interface has programming samples using many major
programming languages. If you are not familiar with HTTP, please
Google the web and you should be able to find plenty of libraries,
samples, and tutorials.
To create a new appointment programmatically, you need to send
HTTP POST request to Voicent AutoReminder URL followed by "/addHandler". Here are the parameters
you need to set.
Parameter |
Meaning |
Value |
contact |
Attendee contact |
name (comma
separated for group) |
phone |
Attendee
phone |
phone number
(comma separated) |
year |
Appointment
year |
year |
month |
Appointment month |
Jan, Feb, ... |
date |
Appointment
date |
1, 2, ... 31 |
shour |
Appointment start hour |
12 pm, ... 11 pm |
sminute |
Appointment
start minute |
:00, :05,
... |
ehour |
Appointment end hour |
12 pm , 1 am , ... |
eminute |
Appointment
end minute |
:00, :05,
... |
makecall |
Make reminder call |
on |
calltype |
reminder
call type |
now, callat,
callbefore |
stdmsg |
reminder call message |
<System Provided>, any
customized |
cyear |
reminder
call year |
year |
cmonth |
reminder call month |
Jan, Feb, ... |
cdate |
reminder
call date |
1, 2, ... 31 |
chour |
reminder call hour |
12 pm, ... 11 pm |
cminute |
reminder
call minute |
:00, :05,
... |
cbnum |
reminder call before |
1, 2, ... |
cbunit |
reminder
call before unit |
Day, Hour,
Minute |
notes |
appointment notes |
any text |
includenotes |
include
notes in call |
on |
room |
appointment room |
any room |
cat |
appointment category |
any text |
user |
calendar user |
only for multi-user license |
wavfile |
audio file included |
full file path name |
confirm |
need confirmation |
on, 1, or any none 0 digit |
|
Delete Appointment Programmatically
To delete an appointment, you need to send HTTP GET/POST request
to Voicent AutoReminder "/delHandler". Here are the parameters.
Parameter |
Meaning |
Value |
fpath |
appointment
ID |
value in [ ]
when addHandler returned |
|
List Appointment Programmatically
To list appointments for a particular date, you need to send HTTP GET/POST request
to Voicent AutoReminder "/listHandler". Here are the parameters.
Parameter |
Meaning |
Value |
year |
year |
year |
month |
month |
Jan, Feb, ... |
date |
date |
1, 2, ... 31 |
|
Get Appointment Status
To get status and confirmation status of an appointment, you need to send HTTP GET/POST request
to Voicent AutoReminder "/statusHandler". Here are the parameters.
Parameter |
Meaning |
Value |
fpath |
appointment
ID |
value in [ ]
when addHandler returned |
|
Get Appointment Reminder Call Report
To get reminder call report of an appointment, you need to send HTTP GET/POST request
to Voicent AutoReminder "/reportHandler". Here are the parameters.
Parameter |
Meaning |
Value |
fpath |
appointment
ID |
value in [ ]
when addHandler returned |
|
Callpad Sample
This is a MFC sample program that utilizes the Openweb Access
interface. Click here to download the sample
code.
|