IVR Component
Properties Methods Events Config Settings Errors
The IVR component can be used to implement an Interactive Voice Response (IVR) menu.
Syntax
TipvIVR
Remarks
The IVR component can be used to implement an IVR menu utilizing modern Voice over Internet Protocol (VoIP) technology. This softphone offers a comprehensive set of features, including the ability to handle incoming calls, detect touch-tone inputs from the caller, and perform other common Voice over Internet Protocol (VoIP) operations. With this, you have a level of flexibility and control when it comes to designing and customizing menu options.
Registration
To begin, the first step is activating, or registering, the component. The Server, Port, User, and Password properties must be set to the appropriate values to register with your SIP server/provider. After these values are set, call Activate. If the component has successfully activated/registered, the Activated event will fire and Active will be set to true. The component will now be able to make/receive phone calls. For example:
component.OnActivated += (o, e) => {
Console.WriteLine("Activation Successful");
};
component.User = "sip_user";
component.Password = "sip_password";
component.Server = "sip_server";
component.Port = 5060 // Default, 5061 is typical for SSL/TLS
component.Activate();
Additionally, it's important to note that the registration of a SIP client will expire if not refreshed. The expiration time is negotiated with the server when registering.
By default, the component will attempt to negotiate a value of 60 seconds. This value can be changed via the RegistrationInterval configuration.
Note this is merely a suggestion to the server, and the server can change this accordingly. If the server does change this, after registration is complete, RegistrationInterval will be updated.
To prevent the registration from expiring, the component will refresh the registration within DoEvents, when needed. To ensure this occurs, we recommend calling DoEvents frequently. In a form-based application, we recommend doing so within a timer. For example, this could look something like:
private void timer1_Tick(object sender, EventArgs e)
{
component.DoEvents();
}
private System.Windows.Forms.Timer timer1;
timer1.Interval = 1000;
timer1.Tick += new System.EventHandler(this.timer1_Tick);
timer1.Enabled = true;
Note that in console applications, you must call DoEvents in a loop in order to provide accurate message processing, in addition to this case.
Security
By default, the component operates in plaintext for both SIP signaling and RTP (audio) communication. To enable completely secure communication using the component, both SIPS (Secure SIP) and SRTP (Secure RTP) must be enabled.
Enable SIPS
To enable SIPS (Secure SIP, or SIP over SSL/TLS), the SIPTransportProtocol property must be set to 2 (TLS). The Port property will typically need to be set to 5061 (this may vary). Additionally, the SSLServerAuthentication event must be handled, allowing users to check the server identity and other security attributes related to server authentication. Once this is complete, the component can then be activated. All subsequent SIP signaling will now be secured. For example:
component.OnSSLServerAuthentication += (o, e) => {
if (!e.Accept) {
if (e.CertSubject == "SIPS_SAMPLE_SUBJECT" && e.CertIssuer == "SIPS_CERT_ISSUER") {
e.Accept = true;
}
}
};
// Enable SIPS
component.SIPTransportProtocol = 2; // TLS
component.User = "sip_user";
component.Password = "sip_password";
component.Server = "sip_server";
component.Port = 5061; // 5061 is typical for SSL/TLS
component.Activate();
Information related to the SSL/TLS handshake will be available within the SSLStatus event with the prefix [SIP TLS].
Enable SRTP
While the above process secures SIP signaling, it does not secure RTP (audio) communication. The RTPSecurityMode property can be used to specify the security mode that will be used when transmitting RTP packets. By default, this property is 0 (None), and RTP packets will remain unencrypted during communication with the remote party.
To ensure the audio data is encrypted and SRTP is enabled, the RTPSecurityMode must be set to either of the following modes: 1 (SDES), or 2 (DTLS-SRTP). The selected mode will be used to securely derive a key used to encrypt and decrypt RTP packets, enabling secure audio communication with the remote party. The appropriate mode to use may depend on the service provider and configuration of a particular User. For example:
component.OnSSLServerAuthentication += (o, e) => {
if (!e.Accept) {
if (e.CertSubject == "SIPS_SAMPLE_SUBJECT" && e.CertIssuer == "SIPS_CERT_ISSUER") {
e.Accept = true;
}
}
};
component.RTPSecurityMode = 1; // Enable SRTP (SDES)
//component.RTPSecurityMode = 2; // Enable SRTP (DTLS-SRTP)
component.SIPTransportProtocol = 2; // TLS
component.User = "sip_user";
component.Password = "sip_password";
component.Server = "sip_server";
component.Port = 5061; // 5061 is typical for SSL/TLS
component.Activate();
component.Dial("123456789", "", true);
Note it is highly recommended that SIPTransportProtocol is set to TLS when enabling SRTP. Additionally, if SRTP is enabled, the remote party must support the selected mode, otherwise no call will be established.
Handle Incoming Calls
After successful activation, incoming calls will be detected, and IncomingCall will fire for each call. Within this event, Answer or Decline can be used to handle these calls. For example:
ivr1.OnIncomingCall += (o, e) => {
ivr1.Answer(e.CallId);
};
Automated Responses
Throughout the menu, there are various ways to prompt a caller. For example, you may want to play an initial message to an answered call. Once a call has been answered, the CallReady event will fire, where you can use either PlayText, PlayFile, or PlayBytes to do so. For example:
ivr1.OnCallReady += (o, e) => {
ivr1.PlayText(e.CallId, "Please press 1 to be transferred to sales. Press 2 to be transferred to support. Press 3 to hear the options again.");
};
Only audio data with a sampling rate of 8 kHz and a bit depth of 16 bits per sample can be played (PCM 8 kHz 16-bit format). Note that these methods are non-blocking. The component can play audio to multiple calls at once.
Once the audio has finished playing to a particular call, the Played event will fire, with the CallId as a parameter. Please see PlayBytes and Played for more information on expected behavior when playing bytes.
Handle User Input
A main focus of an IVR menu revolves around handling user input. The component keeps track of the touch-tone inputs of a caller in the call's "UserInput" field. Additionally, the Digit event will fire whenever user input is detected. The event will contain parameters for the Digit pressed, and the associated CallId. The component can detect digits 0-9, *, and # tones. Based on current and previous inputs, you can implement various menu options, from transferring calls to certain extensions, checking a user's account status, placing user's on hold, etc. For example:
ivr1.OnDigit += (o, e) => {
if (e.Digit.Equals("1")) {
ivr1.Transfer(e.CallId, "Sales Number");
} else if (e.Digit.Equals("2")) {
ivr1.Transfer(e.CallId, "Support Number");
} else if (e.Digit.Equals("3")) {
ivr1.PlayText(e.CallId, "Please press 1 to be transferred to sales. Press 2 to be transferred to support. Press 3 to hear the options again.");
} else {
// Unhandled input
}
};
Call Termination
Ongoing calls are terminated by passing the appropriate Call-ID to Hangup. All ongoing calls can be terminated with HangupAll. When a call has been terminated (by either party), CallTerminated will fire.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
Active | The current activation status of the component. |
Calls | A collection of calls. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | The UDP port in the local host where UDP binds. |
Password | The password that is used when connecting to the SIP Server. |
Port | The port on the SIP server the component is connecting to. |
RTPSecurityMode | Specifies the security mode that will be used when transmitting RTP. |
Server | The address of the SIP Server. |
SIPTransportProtocol | Specifies the transport protocol the component will use for SIP signaling. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
User | The username that is used when connecting to the SIP Server. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Activate | Activates the component. |
Answer | Answers an incoming phone call. |
Config | Sets or retrieves a configuration setting. |
Deactivate | Deactivates the component. |
Decline | Declines an incoming phone call. |
Dial | Used to make a call. |
DoEvents | Processes events from the internal message queue. |
Hangup | Used to hang up a specific call. |
HangupAll | Used to hang up all calls. |
Hold | Places a call on hold. |
Ping | Used to ping the server. |
PlayBytes | This method is used to play bytes to a call. |
PlayFile | Plays audio from a WAV file to a call. |
PlayText | Plays audio from a string to a call using Text-to-Speech. |
Reset | Reset the component. |
StartRecording | Used to start recording the audio of a call. |
StopPlaying | Stops audio from playing to a call. |
StopRecording | Stops recording the audio of a call. |
Transfer | Transfers a call. |
Unhold | Takes a call off hold. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
Activated | This event is fired immediately after the component is activated. |
CallReady | This event is fired after a call has been answered, declined, or ignored. |
CallStateChanged | This event is fired after a call's state has changed. |
CallTerminated | This event is fired after a call has been terminated. |
Deactivated | This event is fired immediately after the component is deactivated. |
DialCompleted | This event is fired after the dial process has finished. |
Digit | This event fires every time a digit is pressed using the keypad. |
Error | Information about errors during data delivery. |
IncomingCall | This event is fired when there's an incoming call. |
Log | This event is fired once for each log message. |
OutgoingCall | This event is fired when an outgoing call has been made. |
Played | This event is fired after the component finishes playing available audio. |
Record | This event is fired when recorded audio data is available. |
Silence | This event is fired when the component detects silence from incoming audio streams. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AuthUser | Specifies the username to be used during client authentication. |
Codecs | Comma-separated list of codecs the component can use. |
DialTimeout | Specifies the amount of time to wait for a response when making a call. |
Domain | Can be used to set the address of the SIP domain. |
DtmfMethod | The method used for delivering the signals/tones sent when typing a digit. |
LogEncodedAudioData | Whether the component will log encoded audio data. |
LogLevel | The level of detail that is logged. |
LogRTPPackets | Whether the component will log RTP packets. |
RecordType | The type of recording the component will use. |
RedirectLimit | The maximum number of redirects an outgoing call can experience. |
RegistrationInterval | Specifies the interval between subsequent registration messages. |
SilenceInterval | Specifies the interval the component uses to detect periods of silence. |
STUNPort | The port of the STUN server. |
STUNServer | The address of the STUN Server. |
UnregisterOnActivate | Specifies whether the component will unregister from the SIP Server before registration. |
VoiceIndex | The voice that will be used when playing text. |
VoiceRate | The speaking rate of the voice when playing text. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |
Active Property (IVR Component)
The current activation status of the component.
Syntax
property Active: Boolean read get_Active;
Default Value
false
Remarks
This property indicates the activation status of the component. Active will be True if the component has been successfully activated (registered) with the SIP Server, and False otherwise. If False, the component is not registered and will not be able to make or receive calls.
The component can be activated via Activate and deactivated through Deactivate.
This property is read-only and not available at design time.
Calls Property (IVR Component)
A collection of calls.
Syntax
property Calls: TipvCallList read get_Calls;
Remarks
This collection holds data for each incoming and outgoing Call recognized by the component.
This property is read-only and not available at design time.
Please refer to the Call type for a complete list of fields.LocalHost Property (IVR Component)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
property LocalHost: String read get_LocalHost write set_LocalHost;
Default Value
''
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.
If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.
LocalPort Property (IVR Component)
The UDP port in the local host where UDP binds.
Syntax
property LocalPort: Integer read get_LocalPort write set_LocalPort;
Default Value
0
Remarks
The LocalPort property must be set before UDP is activated (Active is set to True). It instructs the component to bind to a specific port (or communication endpoint) in the local machine.
Setting it to 0 (default) enables the TCP/IP stack to choose a port at random. The chosen port will be shown by the LocalPort property after the connection is established.
LocalPort cannot be changed once the component is Active. Any attempt to set the LocalPort property when the component is Active will generate an error.
The LocalPort property is useful when trying to connect to services that require a trusted port in the client side.
Password Property (IVR Component)
The password that is used when connecting to the SIP Server.
Syntax
property Password: String read get_Password write set_Password;
Default Value
''
Remarks
This property contains the password of the client attempting to connect to the SIP Server. This value will be used when activating the component via Activate.
This property is not available at design time.
Port Property (IVR Component)
The port on the SIP server the component is connecting to.
Syntax
property Port: Integer read get_Port write set_Port;
Default Value
5060
Remarks
This property specifies the port on the SIP server that the component will connect to. This value will be used when activating the component via Activate.
RTPSecurityMode Property (IVR Component)
Specifies the security mode that will be used when transmitting RTP.
Syntax
property RTPSecurityMode: TipvTRTPSecurityModes read get_RTPSecurityMode write set_RTPSecurityMode;
TipvTRTPSecurityModes = ( etNone, etSDES, etDTLS );
Default Value
etNone
Remarks
This property is used to specify the security mode that will be used when transmitting RTP (audio data). Possible modes are:
0 (None) | SRTP is disabled. |
1 (SDES) | SRTP is enabled, utilizing SDES. |
2 (DTLS) | SRTP is enabled, utilizing DTLS (DTLS-SRTP). |
By default, the security mode will be 0 (None), and RTP packets will remain unencrypted during communication with the remote party. To enable SRTP (Secure RTP), the security mode must be set to either: 1 (SDES), or 2 (DTLS).
When SRTP is enabled, the selected mode will be used to securely derive a key used to encrypt and decrypt RTP packets, enabling secure audio communication with the remote party. The appropriate mode to use may depend on the service provider and configuration of a particular User. Additionally, if SRTP is enabled, the remote party must support the selected mode, otherwise no call will be established.
Note it is highly recommended that SIPTransportProtocol is set to TLS when enabling SRTP.
Server Property (IVR Component)
The address of the SIP Server.
Syntax
property Server: String read get_Server write set_Server;
Default Value
''
Remarks
This property contains the address of the SIP Server the component will attempt to connect to. This value will be used when activating the component via Activate.
SIPTransportProtocol Property (IVR Component)
Specifies the transport protocol the component will use for SIP signaling.
Syntax
property SIPTransportProtocol: TipvTSIPTransportProtocols read get_SIPTransportProtocol write set_SIPTransportProtocol;
TipvTSIPTransportProtocols = ( tpUDP, tpTCP, tpTLS );
Default Value
tpUDP
Remarks
This property specifies which transport protocol (UDP, TCP, TLS) the component will use for SIP signaling and can be used to enable SIPS (Secure SIP). Note it is important to set the SIPTransportProtocol property before setting any additional properties and configurations.
This value is 0 (UDP) by default. Possible values are:
0 (UDP - Default) | Signaling will be performed over UDP (plaintext). |
1 (TCP) | Signaling will be performed over TCP (plaintext). |
2 (TLS) | Signaling will be performed using TLS over TCP (SIPS). |
Note when TLS is specified, the Port will typically need to be set to 5061.
SSLAcceptServerCertEncoded Property (IVR Component)
This is the certificate (PEM/base64 encoded).
Syntax
property SSLAcceptServerCertEncoded: String read get_SSLAcceptServerCertEncoded write set_SSLAcceptServerCertEncoded; property SSLAcceptServerCertEncodedB: TBytes read get_SSLAcceptServerCertEncodedB write set_SSLAcceptServerCertEncodedB;
Default Value
''
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
This property is not available at design time.
SSLCertEncoded Property (IVR Component)
This is the certificate (PEM/base64 encoded).
Syntax
property SSLCertEncoded: String read get_SSLCertEncoded write set_SSLCertEncoded; property SSLCertEncodedB: TBytes read get_SSLCertEncodedB write set_SSLCertEncodedB;
Default Value
''
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
This property is not available at design time.
SSLCertStore Property (IVR Component)
This is the name of the certificate store for the client certificate.
Syntax
property SSLCertStore: String read get_SSLCertStore write set_SSLCertStore; property SSLCertStoreB: TBytes read get_SSLCertStoreB write set_SSLCertStoreB;
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
This property is not available at design time.
SSLCertStorePassword Property (IVR Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
property SSLCertStorePassword: String read get_SSLCertStorePassword write set_SSLCertStorePassword;
Default Value
''
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
This property is not available at design time.
SSLCertStoreType Property (IVR Component)
This is the type of certificate store for this certificate.
Syntax
property SSLCertStoreType: TipvCertStoreTypes read get_SSLCertStoreType write set_SSLCertStoreType;
TipvCertStoreTypes = ( cstUser, cstMachine, cstPFXFile, cstPFXBlob, cstJKSFile, cstJKSBlob, cstPEMKeyFile, cstPEMKeyBlob, cstPublicKeyFile, cstPublicKeyBlob, cstSSHPublicKeyBlob, cstP7BFile, cstP7BBlob, cstSSHPublicKeyFile, cstPPKFile, cstPPKBlob, cstXMLFile, cstXMLBlob, cstJWKFile, cstJWKBlob, cstSecurityKey, cstBCFKSFile, cstBCFKSBlob, cstPKCS11, cstAuto );
Default Value
cstUser
Remarks
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used the component will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example: SSH Authentication with Security Key
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
This property is not available at design time.
SSLCertSubject Property (IVR Component)
This is the subject of the certificate used for client authentication.
Syntax
property SSLCertSubject: String read get_SSLCertSubject write set_SSLCertSubject;
Default Value
''
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
This property is not available at design time.
User Property (IVR Component)
The username that is used when connecting to the SIP Server.
Syntax
property User: String read get_User write set_User;
Default Value
''
Remarks
This property contains the username of the client attempting to connect to the SIP Server. This value will be used when activating the component via Activate.
This property is not available at design time.
Activate Method (IVR Component)
Activates the component.
Syntax
procedure Activate();
Remarks
This method is used to activate the component by registering to a SIP Server specified in the Server and Port properties. The username and password of the SIP Server must be provided via User and Password properties for authorization, if applicable.
Example:
ipphone.User = "MyUsername";
ipphone.Password = "MyPassword";
ipphone.Server = "HostNameOrIP";
ipphone.Port = 5060;
ipphone.Activate();
Upon successful activation, the Activated event will fire.
Answer Method (IVR Component)
Answers an incoming phone call.
Syntax
procedure Answer(callId: String);
Remarks
This method can be used to answer an incoming phone call, specified by callId. This method can
be used in conjunction with the IncomingCall event, for example:
ipphone.onIncomingCall += (sender, e) => {
ipphone.Answer(e.CallId);
};
If successful, CallReady will fire.
Config Method (IVR Component)
Sets or retrieves a configuration setting.
Syntax
function Config(ConfigurationString: String): String;
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Deactivate Method (IVR Component)
Deactivates the component.
Syntax
procedure Deactivate();
Remarks
This method is used to unregister the component from the SIP Server. If deactivation is successful, Deactivated will fire.
Decline Method (IVR Component)
Declines an incoming phone call.
Syntax
procedure Decline(callId: String);
Remarks
This method can be used to decline an incoming phone call, specified by callId. This method can
be used in conjunction with the IncomingCall event, for example:
ipphone.onIncomingCall += (sender, e) => {
ipphone.Decline(e.CallId);
};
Dial Method (IVR Component)
Used to make a call.
Syntax
function Dial(number: String; callerNumber: String; wait: Boolean): String;
Remarks
This method is used to make a call to a particular user, given by number. This method should only be called after the component has been successfully activated via Activate. Initially, the OutgoingCall event will fire after calling this method. DialCompleted may fire when the dial process is complete. If successful, CallReady will fire after the outgoing call has been answered, declined, or ignored. If the call is declined or ignored, the component will be sent to voicemail, which can be ended with Hangup.
The callerNumber parameter specifies the optional caller ID. If given, the P-Asserted-Identity Header, specified in RFC 3325, will be sent in requests to the connected SIP Server. If left as an empty string, this header will not be sent.
The wait parameter specifies whether the component should connect synchronously or asynchronously to the call. If True, the component will connect synchronously, and won't return until the call has been answered, declined, or ignored. If False, the component will connect asynchronously. The call's status can be checked through various events, such as OutgoingCall, CallReady, and CallStateChanged, or found in the call's State field. Exceptions throughout the call process will be reported in DialCompleted, along with other call details.
NOTE: This method will return the CallId field of the call. This returned value may not always reflect the accurate CallId. In the case that wait is true, this method will always return the accurate value. In the case that wait is false, the returned value may not be accurate if the outgoing call is forwarded, or redirected, as the component must change this field. Both the updated and original CallId will be present within the DialCompleted event. Any references to the original CallId must be updated accordingly. Please see DialCompleted for more details. The below examples assume the outgoing call has been answered:
Example: "wait" is true
string callId = "";
bool connected = false;
ipphone.OnCallReady += (sender, e) => {
connected = true;
}
try {
callId = ipphone.Dial("123456789", "", true);
} catch (IPWorksVoIPException e) {
MessageBox.Show(e.Code + ": " + e.Message);
}
if (connected) {
ipphone.PlayText(callId, "Hello");
}
Example: "wait" is false
bool connected = false;
string callId = "";
ipphone.OnDialCompleted += (sender, e) => {
if (e.ErrorCode != 0) {
MessageBox.Show(e.ErrorCode + ": " + e.Description);
// Handle error
}
if (e.OriginalCallId != e.CallId) {
callId = e.CallId; // Update callId if redirect occurred
}
}
ipphone.OnCallReady += (sender, e) => {
connected = true;
}
string callId = ipphone.Dial("123456789", "", false);
...
...
...
// Somewhere else...
if (connected) {
ipphone.PlayText(callId, "Hello");
}
DoEvents Method (IVR Component)
Processes events from the internal message queue.
Syntax
procedure DoEvents();
Remarks
When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Hangup Method (IVR Component)
Used to hang up a specific call.
Syntax
procedure Hangup(callId: String);
Remarks
This method is used to terminate a specific call, specified by callId. After the call has been successfully terminated, CallTerminated will fire.
HangupAll Method (IVR Component)
Used to hang up all calls.
Syntax
procedure HangupAll();
Remarks
This method is used to terminate all calls currently in the Calls collection. CallTerminated will fire for each successfully terminated call.
Hold Method (IVR Component)
Places a call on hold.
Syntax
procedure Hold(callId: String);
Remarks
This method is used to place a call, specified by callId, on hold.
Ping Method (IVR Component)
Used to ping the server.
Syntax
procedure Ping(timeout: Integer);
Remarks
This method is used to ping the SIP server by sending an OPTIONS request. If no server response is received by the component in timeout seconds, Ping will throw an error.
Note this method is only applicable when the component is active.
PlayBytes Method (IVR Component)
This method is used to play bytes to a call.
Syntax
procedure PlayBytes(callId: String; bytesToPlay: TBytes; lastBlock: Boolean);
Remarks
This method is used to play bytes to a call, specified by the callId parameter. These bytes are expected to have a sampling rate of 8 kHz and a bit depth of 16 bits per sample (PCM 8 kHz 16-bit format). The bytesToPlay parameter specifies the bytes that will be sent to the call. Internally, these bytes will be stored within a buffer. Once all bytes have played and the buffer is empty, the Played event will fire.
The lastBlock parameter indicates whether the component will expect further uses of PlayBytes. When true, this indicates that no additional bytes will be provided for this particular audio stream, and Played will fire once after the bytes have been played. Until this parameter is specified as true, the component will be considered to be playing audio.
If lastBlock is false, this indicates that the component should expect more calls to PlayBytes. Once all bytes have played and the buffer is empty, Played will fire as expected, and will continue firing until the lastBlock parameter is set to true. Within Played, the user can provide further bytes to PlayBytes. Please see below for detailed examples on how to use this method with Played.
Example: Playing audio from a stream
MemoryStream playBytesStream = new MemoryStream(byteSource);
phone.PlayBytes("callId", new byte[0], false);
phone.OnPlayed += (o, e) => {
if (e.Completed) {
Console.WriteLine("Playing Bytes Completed");
} else {
byte[] data = new byte[4096]; // Arbitrary length
int dataLen = playBytesStream.Read(data, 0, data.Length);
if (dataLen > 0) {
byte[] newData = new byte[dataLen];
Array.Copy(data, newData, dataLen) // Normalize array
phone.PlayBytes(e.CallId, newData, false);
} else {
phone.PlayBytes(e.CallId, null, true);
}
}
};
Exmaple: Playing single audio block
MemoryStream playBytesStream = new MemoryStream(byteSource);
phone.PlayBytes("callId", playBytesStream.ToArray(), true);
phone.OnPlayed += (o, e) => {
Console.WriteLine("Done!"); // No further calls to PlayBytes are expected in this case
}
PlayFile Method (IVR Component)
Plays audio from a WAV file to a call.
Syntax
procedure PlayFile(callId: String; wavFile: String);
Remarks
This method is used to play the audio from a WAV file to a particular call, given by callId. Audio transmission will only occur when the call has connected and CallReady has fired. Only WAV files with a sampling rate of 8 kHz and a bit depth of 16 bits per sample are supported (PCM 8 kHz 16-bit format).
Note that this component can handle playing audio to concurrent calls. This method is non-blocking and will return immediately. The Played event will fire when the audio for the specified call has finished playing. Consecutive uses of PlayText or PlayFile can prevent prior audio transmissions from being completed. In the below example, Played will only fire for the second call to PlayText:
ipphone.PlayFile("callId", "C:\\hello.wav"); // Played will not fire for this
ipphone.PlayText("callId", "This will interrupt the previous use if it has not finished playing.");
The wavFile parameter specifies the path to the WAV file.
PlayText Method (IVR Component)
Plays audio from a string to a call using Text-to-Speech.
Syntax
procedure PlayText(callId: String; text: String);
Remarks
This method is used to play the text from a string to a particular call, given by callId, using Text-to-Speech. Audio transmission will only occur when the call has connected and CallReady has fired.
Note that this component can handle playing audio to concurrent calls. This method is non-blocking and will return immediately. The Played event will fire when the audio for the specified call has finished playing. Consecutive uses of PlayText and PlayFile can prevent prior audio transmissions from completing. In the below example, Played will only fire for the second call to PlayText:
ipphone.PlayFile("callId", "C:\\hello.wav"); // Played will not fire for this
ipphone.PlayText("callId", "This will interrupt the previous use if it has not finished playing.");
The text parameter must be a string representation of the text to be transmitted.
Reset Method (IVR Component)
Reset the component.
Syntax
procedure Reset();
Remarks
This method will reset the component's properties to their default values.
StartRecording Method (IVR Component)
Used to start recording the audio of a call.
Syntax
procedure StartRecording(callId: String; filename: String);
Remarks
This method is used to start recording the incoming and outgoing audio of a call, specified by callId. If you wish to record the audio to file, you may specify the filename parameter. Note that when this parameter is specified, you must record to a WAV file.
You may also leave the filename parameter blank if you want more direct control over the recorded data. This will cause the Record event to fire containing the call's audio data once the recording is finished.
In both scenarios, you can stop recording the call's audio via StopRecording. By default, the recording will end if the call is terminated. Note the recorded audio will have a sampling rate of 8 kHz and a bit depth of 16 bits per sample (PCM 8 kHz 16-bit format).
Example: Using the 'Record' event
MemoryStream recordStream = new MemoryStream();
phone.StartRecording("callId", "");
phone.OnRecord += (o, e) => {
recordStream.Write(e.RecordedDataB, 0, e.RecordedDataB.Length);
File.WriteAllBytes(recordFile, recordStream.ToArray());
};
StopPlaying Method (IVR Component)
Stops audio from playing to a call.
Syntax
procedure StopPlaying(callId: String);
Remarks
This method is used to stop the audio playing to a call, given by callId. Note that this will not stop audio from transmitting with an external device set using SetMicrophone, however, will stop audio transmitting from usage of PlayText, PlayFile, and PlayBytes.
Note that Played will not fire when this method is used.
StopRecording Method (IVR Component)
Stops recording the audio of a call.
Syntax
procedure StopRecording(callId: String);
Remarks
This method is used to stop recording the audio of a call, given by callId. The component will automatically stop recording upon call termination.
Transfer Method (IVR Component)
Transfers a call.
Syntax
procedure Transfer(callId: String; number: String);
Remarks
This method is used to transfer a call, specified by callId, to the phone number given by number. The component supports the following types of transfers:
Basic Transfers
Basic transfers are very simple to perform. First, the user must establish a call with the number they will be transferring (transferee). After the call is established, the user can transfer the call to the appropriate number (transfer target). The call will then be removed. For example:
string callId = ipphone1.Dial("123456789", "", true); // Establish call with transferee, hold if needed
//ipphone1.Hold(callId);
ipphone1.Transfer(callId, "number");
Attended Transfers
Typically, attended transfers are used to manually check if the number (or transfer target) is available for a call, provide extra information about the call, etc., before transferring. In addition to establishing a call with the transferee, the component must also establish a call with the transfer target. Once both of these calls are active, you may perform an attended transfer by calling Transfer at any moment. Afterwards, a session between these calls will be established and they will be removed. Note that Transfer must be used with the callId of the call you wish to transfer (transferee) and the number of the call you wish to transfer to (transfer target). For example:
string callId1 = ipphone1.Dial("123456789", "", true); // Establish call with Transferee, hold if needed
//ipphone1.Hold(callId1);
string callId2 = ipphone1.Dial("number", "", true); // Establish call with Transfer Target, hold if needed
//ipphone1.Hold(callId2);
ipphone1.Transfer(callId1, "number");
Note in these examples, Hold can be used to place a call on hold before a transfer. This is optional.
Unhold Method (IVR Component)
Takes a call off hold.
Syntax
procedure Unhold(callId: String);
Remarks
This method is used to take a call, specified by callId, off hold.
Activated Event (IVR Component)
This event is fired immediately after the component is activated.
Syntax
type TActivatedEvent = procedure ( Sender: TObject ) of Object;
property OnActivated: TActivatedEvent read FOnActivated write FOnActivated;
Remarks
The Activated event will fire after the component has successfully registered with the SIP Server via Activate.
CallReady Event (IVR Component)
This event is fired after a call has been answered, declined, or ignored.
Syntax
type TCallReadyEvent = procedure ( Sender: TObject; const CallId: String ) of Object;
property OnCallReady: TCallReadyEvent read FOnCallReady write FOnCallReady;
Remarks
For all calls, this event will fire when audio can be transmitted and received. For incoming calls, it will fire after the call has been answered.
For outgoing calls, this event will fire after the call has either been answered, declined, or ignored. In the case that the call is declined or ignored, it will fire and the component will be sent to voicemail. Hangup can be used to end the call in all scenarios.
Note that this event will fire after OutgoingCall and DialCompleted, assuming Dial was successful.
The CallId parameter is the unique Call-ID of the call.
CallStateChanged Event (IVR Component)
This event is fired after a call's state has changed.
Syntax
type TCallStateChangedEvent = procedure ( Sender: TObject; const CallId: String; State: Integer ) of Object;
property OnCallStateChanged: TCallStateChangedEvent read FOnCallStateChanged write FOnCallStateChanged;
Remarks
The CallStateChanged event will fire each time the state of a call has changed.
The CallId parameter is the unique Call-ID of the call.
The State parameter denotes the state the call has changed to. The following values are applicable:
csInactive (0) | The call is inactive (default setting). |
csConnecting (1) | The call is establishing a connection to the callee. |
csAutConnecting (2) | The call is establishing a connection to the callee with authorization credentials. |
csRinging (3) | The call is ringing. |
csActive (4) | The call is active. |
csActiveInConference (5) | The call is active and in a conference. |
csDisconnecting (6) | The call is disconnecting with the callee. |
csAutDisconnecting (7) | The call is disconnecting with the callee with authorization credentials. |
csHolding (8) | The call is currently being placed on hold, but the Hold operation has not finished. |
csOnHold (9) | The call is currently on hold. |
csUnholding (10) | The call is currently being unheld, but the Unhold operation has not finished. |
csTransferring (11) | The call is currently being transferred. |
csAutTransferring (12) | The call is currently being transferred with authorization credentials. |
CallTerminated Event (IVR Component)
This event is fired after a call has been terminated.
Syntax
type TCallTerminatedEvent = procedure ( Sender: TObject; const CallId: String ) of Object;
property OnCallTerminated: TCallTerminatedEvent read FOnCallTerminated write FOnCallTerminated;
Remarks
The CallTerminated event will fire after a call has been terminated by either end of the call.
The CallId parameter is the unique Call-ID of the call.
Deactivated Event (IVR Component)
This event is fired immediately after the component is deactivated.
Syntax
type TDeactivatedEvent = procedure ( Sender: TObject ) of Object;
property OnDeactivated: TDeactivatedEvent read FOnDeactivated write FOnDeactivated;
Remarks
The Deactivated event will fire after the component has unregistered from the SIP Server via Deactivate.
DialCompleted Event (IVR Component)
This event is fired after the dial process has finished.
Syntax
type TDialCompletedEvent = procedure ( Sender: TObject; const OriginalCallId: String; const CallId: String; const Caller: String; const Callee: String; ErrorCode: Integer; const Description: String ) of Object;
property OnDialCompleted: TDialCompletedEvent read FOnDialCompleted write FOnDialCompleted;
Remarks
This event will fire when the dial process, initiated by calling Dial, has completed. Note that this event will not fire if an exception occurs when the "wait" parameter of Dial is true. In this case, the component will throw an exception. However, it will fire if "wait" is true and no exception occurs, indicating Dial was successful.
The OriginalCallId parameter is the value returned by Dial.
The value of the CallId parameter depends on the redirection status of the call. There are two scenarios:
- The outgoing call has not been redirected. In this case, CallId is equal to OriginalCallId, and the value returned by Dial is correct.
- The outgoing call has been redirected any number of times. In this case, the OriginalCallId is no longer applicable, and the CallId parameter is the new unique identifier for this call. Any reference to the past value, OriginalCallId, should be updated accordingly to reflect the change due to redirection. This would also include references to the original value returned by Dial.
Errors during the dial process are reported via the ErrorCode and Description parameters. An error code of 0 and description of "Dialed Successfully" indicate Dial has completed with no issues. A list of error codes can be found in the Error Codes section. In the case of a non-zero ErrorCode, the Description parameter will contain the error message (and SIP response code, if applicable), for example, "Dial Timeout" or "486: Busy Here".
Digit Event (IVR Component)
This event fires every time a digit is pressed using the keypad.
Syntax
type TDigitEvent = procedure ( Sender: TObject; const CallId: String; const Digit: String ) of Object;
property OnDigit: TDigitEvent read FOnDigit write FOnDigit;
Remarks
The Digit event will fire after every detected keypad input from a call.
The detected input will be present in the Digit parameter. Note, this event will not fire after the component's inputs via TypeDigit. Detectable inputs include: 0-9, *, #
The CallId parameter is the unique Call-ID of the call.
Error Event (IVR Component)
Information about errors during data delivery.
Syntax
type TErrorEvent = procedure ( Sender: TObject; ErrorCode: Integer; const Description: String ) of Object;
property OnError: TErrorEvent read FOnError write FOnError;
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
IncomingCall Event (IVR Component)
This event is fired when there's an incoming call.
Syntax
type TIncomingCallEvent = procedure ( Sender: TObject; const CallId: String; const RemoteUser: String ) of Object;
property OnIncomingCall: TIncomingCallEvent read FOnIncomingCall write FOnIncomingCall;
Remarks
The IncomingCall event will fire after an incoming call is detected.
The CallId parameter specifies the unique Call-ID of the call, and can be used to Answer or Decline the call.
The RemoteUser parameter indicates the username or telephone number of the remote user associated with the call.
Log Event (IVR Component)
This event is fired once for each log message.
Syntax
type TLogEvent = procedure ( Sender: TObject; LogLevel: Integer; const Message: String; const LogType: String ) of Object;
property OnLog: TLogEvent read FOnLog write FOnLog;
Remarks
This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel configuration.
LogLevel indicates the detail level of the message. Possible values are:
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as a call's status are logged. |
2 (Verbose) | Detailed data such as SIP/SDP packet information is logged. |
3 (Debug) | Debug data including all relevant sent and received audio bytes are logged. |
Message is the log message.
LogType identifies the type of log entry. Possible values are as follows:
- Info
- Packet
- RTP
OutgoingCall Event (IVR Component)
This event is fired when an outgoing call has been made.
Syntax
type TOutgoingCallEvent = procedure ( Sender: TObject; const CallId: String; const RemoteUser: String ) of Object;
property OnOutgoingCall: TOutgoingCallEvent read FOnOutgoingCall write FOnOutgoingCall;
Remarks
The OutgoingCall event is fired when an outgoing call has been made using Dial. This event signifies the start of the invite process.
The CallId parameter is the unique Call-ID of the call.
The RemoteUser parameter indicates the username or telephone number of the remote user associated with the call.
Played Event (IVR Component)
This event is fired after the component finishes playing available audio.
Syntax
type TPlayedEvent = procedure ( Sender: TObject; const CallId: String; Completed: Boolean ) of Object;
property OnPlayed: TPlayedEvent read FOnPlayed write FOnPlayed;
Remarks
The Played event will fire after the component finishes playing available audio to a call. When using PlayText or PlayFile, Completed will always be true. However, this will not always be the case when using PlayBytes.
When playing audio via PlayBytes, this event will fire when the internal byte queue is empty. In the event that the internal byte queue is empty, and the component is still expecting calls to PlayBytes (i.e., lastBlock is false), this event will continue to fire with the Completed parameter as false. In this case, additional bytes are expected to be provided. Completed will be true once all bytes have been played and the component is no longer expecting calls to PlayBytes (i.e., lastBlock is true). Please see the method description for more details.
The CallId parameter is the unique Call-ID of the call.
Record Event (IVR Component)
This event is fired when recorded audio data is available.
Syntax
type TRecordEvent = procedure ( Sender: TObject; const CallId: String; RecordedData: String; RecordedDataB: TBytes ) of Object;
property OnRecord: TRecordEvent read FOnRecord write FOnRecord;
Remarks
This event is fired when a call's recorded data is available. This data is made available when either StopRecording is called or the call is terminated. Note that for this event to fire, StartRecording must be specified with no filename parameter.
The recorded data will be available in the RecordedData and RecordedDataB parameters, and will have a sampling rate of 8 kHz and a bit depth of 16 bits per sample (PCM 8 kHz 16-bit format).
The CallId parameter is the unique Call-ID of the call.
Silence Event (IVR Component)
This event is fired when the component detects silence from incoming audio streams.
Syntax
type TSilenceEvent = procedure ( Sender: TObject; const CallId: String ) of Object;
property OnSilence: TSilenceEvent read FOnSilence write FOnSilence;
Remarks
The Silence event will fire every second the component detects silence from a call's incoming audio stream. Note that this event can fire while an outgoing call is ringing.
The CallId parameter is the unique Call-ID of the call.
SSLServerAuthentication Event (IVR Component)
Fired after the server presents its certificate to the client.
Syntax
type TSSLServerAuthenticationEvent = procedure ( Sender: TObject; CertEncoded: String; CertEncodedB: TBytes; const CertSubject: String; const CertIssuer: String; const Status: String; var Accept: Boolean ) of Object;
property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;
Remarks
This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (IVR Component)
Shows the progress of the secure connection.
Syntax
type TSSLStatusEvent = procedure ( Sender: TObject; const Message: String ) of Object;
property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
Call Type
Contains the details of an active call.
Remarks
This type contains the details of an active call.
Fields
String representation of an immutable universally unique identifier (UUID) specific to the call.
ConferenceId
String (read-only)
A unique identifier for a conference call.
Elapsed time, in seconds, since the call has begun. Calculated using the value in StartedAt.
This field indicates the call's last response code. Response codes are defined in RFC 3261.
LocalAddress
String (read-only)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
The UDP port in the local host where UDP binds.
The microphone currently in use during the call. Set through SetMicrophone.
This field can be set to mute the Microphone being used by the component in the given call. When True, the Microphone is muted.
This field can be set to mute the Speaker being used by the component in the given call. When True, the Speaker is muted.
Indicates whether the current call is outgoing. If false, the call is incoming.
Indicates whether the current call is playing audio via PlayText or PlayFile, or PlayBytes. After audio transmission is complete, or stopped using StopPlaying, this flag will be false.
Indicates whether the current call is recording the received voice from the peer. When the recording is done, this flag will be false. If the recording is stopped via StopRecording, this flag will be false.
RemoteAddress
String (read-only)
The address of the remote host we are communicating with.
The port of the remote host we are communicating with. This field is typically 5060.
This field communicates who to call via SIP. This value contains the RemoteUser, RemoteAddress, and the RemotePort, and has the following format:
sip:user@host:port
The username or telephone number of the remote user associated with the call.
The speaker currently in use during the call. Set through SetSpeaker.
The number of milliseconds since 12:00:00 AM January 1, 1970 when this call started.
This property indicates the state of the current call. The applicable values are as follows:
csInactive (0) | The call is inactive (default setting). |
csConnecting (1) | The call is establishing a connection to the callee. |
csAutConnecting (2) | The call is establishing a connection to the callee with authorization credentials. |
csRinging (3) | The call is ringing. |
csActive (4) | The call is active. |
csActiveInConference (5) | The call is active and in a conference. |
csDisconnecting (6) | The call is disconnecting with the callee. |
csAutDisconnecting (7) | The call is disconnecting with the callee with authorization credentials. |
csHolding (8) | The call is currently being placed on hold, but the Hold operation has not finished. |
csOnHold (9) | The call is currently on hold. |
csUnholding (10) | The call is currently being unheld, but the Unhold operation has not finished. |
csTransferring (11) | The call is currently being transferred. |
csAutTransferring (12) | The call is currently being transferred with authorization credentials. |
String representation of digits typed by the callee using their keypad.
The Via header sent in the most recent SIP request. Identifies the protocol name/version, transport type, IP Address of the User Agent Client, and port of the request.
Constructors
constructor Create();
Config Settings (IVR Component)
The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.IPPhone Config Settings
By default, this value is empty, and the User property will be used within the mentioned headers.
8,0,3
The following integers correspond to these supported codecs:
0 | PCMU (G711MU) |
3 | GSM |
8 | PCMA (G711A) |
When using Dial with the wait parameter as false, the timeout will be reported within DialCompleted.
1 | Inband (Default) |
2 | RFC 2833 |
3 | Info (SIP Info) |
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as a call's status are logged. |
2 (Verbose) | Detailed data such as SIP/SDP packet information is logged. |
3 (Debug) | Debug data including all relevant sent and received audio bytes are logged. |
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this setting to True tells the component to use the internal implementation instead of using the system security libraries.
This setting is set to False by default on all platforms.
Trappable Errors (IVR Component)
IPPHONE Errors
201 Timeout error. The error description contains detailed information. | |
202 Invalid argument error. The error description contains detailed information. | |
601 Protocol error. The error description contains detailed information. |
UDP Errors
104 UDP is already Active. | |
106 You cannot change the LocalPort while the component is Active. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
109 The component must be Active for this operation. | |
112 Cannot change MaxPacketSize while the component is Active. | |
113 Cannot change ShareLocalPort option while the component is Active. | |
114 Cannot change RemoteHost when UseConnection is set and the component Active. | |
115 Cannot change RemotePort when UseConnection is set and the component is Active. | |
116 RemotePort can't be zero when UseConnection is set. Please specify a valid service port number. | |
117 Cannot change UseConnection while the component is Active. | |
118 Message can't be longer than MaxPacketSize. | |
119 Message too short. | |
434 Unable to convert string to selected CodePage |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |