Cisco Cisco Computer Telephony Integration OS 8.5 Developer's Guide

Page of 500
   
6-14
CTI OS Developer’s Guide for Cisco ICM/IPCC Enterprise & Hosted Editions
Cisco CTI OS Release 7.2(1)
Chapter 6      Event Interfaces and Events
ISessionEvents Interface
The SoundPreferences array contains the following key-value pairs: 
Keyword
Value
Subtree
DTMF
*
Arguments 
array
SoundPreferences/Name/DTMF
DialTone
*
Arguments 
array
SoundPreferences/Name/DialTone
OriginatingTone
*
Arguments 
array
SoundPreferences/Name/OriginatingTone
RingInTone
*
Arguments 
array 
SoundPreferences/Name/RingInTone
All
*
Arguments 
array
SoundPreferences/Name/All
Registry values added to this registry key in the CTI OS server registry are included in the arguments array. Subkeys 
added to this registry key are not present.
The DTMF, DialTone, OriginatingTone, RingInTone, and All arrays each contain the keyword 
Mute, which has a boolean value. Custom registry values added to the DialTone DTMF, 
DialTone, OriginatingTone, RingInTone, and All registry keys are present in the array. Subkeys 
added to the these registry keys are not present in the array.
You can add custom keys in the SoundPreferences subtree at the same level as the All, DTMF, 
DialTone, OriginatingTone, and RingInTone keys. The SoundPreferences array contains items 
corresponding to these custom keys. Any custom element that you add must follow the same 
hierarchy in the registry as that used by the existing top level elements.
The format of the SoundPreferences Arguments array follows.
“All”,<Arguments array>
“Mute”, 0
“DTMF”,<Arguments array>
“Mute”, 0
“CustomerName”,<Arguments array>
“CustomeName”, CustomValue
...
“SoundPreferences”,<Arguments array>
“CustomName”, CustomValue
“CustomName”, CustomValue
 
This configuration is stored in the Windows System Registry database and many of the values 
are set when the CTI OS Server Setup is run. Custom configuration can be set at a later time by 
using the Windows Registry Editor. 
OnHeartbeat
The OnHeartbeat event is generated when a heartbeat response is received from a CTI OS server. It 
returns the time of day.