IVR Class

Properties   Methods   Events   Config Settings   Errors  

The IVR class can be used to implement an Interactive Voice Response (IVR) menu.

Syntax

IVR

Remarks

The IVR class 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 class. 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 class has successfully activated/registered, the Activated event will fire and Active will be set to true. The class 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 class 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 class 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 class operates in plaintext for both SIP signaling and RTP (audio) communication. To enable completely secure communication using the class, 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 class 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 class 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 class 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 class 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 CallId 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 class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Active Property (IVR Class)

The current activation status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetActive();

Unicode (Windows)
BOOL GetActive();

int ipworksvoip_ivr_getactive(void* lpObj);

bool GetActive();

Default Value

FALSE

Remarks

This property indicates the activation status of the class. Active will be True if the class has been successfully activated (registered) with the SIP Server, and False otherwise. If False, the class is not registered and will not be able to make or receive calls.

The class can be activated via Activate and deactivated through Deactivate.

This property is read-only and not available at design time.

Data Type

Boolean

Calls Property (IVR Class)

A collection of calls.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
IPWorksVoIPList<IPWorksVoIPCall>* GetCalls();


Unicode (Windows)
IPWorksVoIPList<IPWorksVoIPCall>* GetCalls();

Default Value

0

Remarks

This collection holds data for each incoming and outgoing Call recognized by the class.

This property is read-only and not available at design time.

Data Type

IPWorksVoIPCall

CallCount Property (IVR Class)

The number of records in the Call arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCallCount();

Unicode (Windows)
INT GetCallCount();

int ipworksvoip_ivr_getcallcount(void* lpObj);

int GetCallCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• CallCallId
• CallConferenceId
• CallDuration
• CallLastStatus
• CallLocalAddress
• CallLocalPort
• CallMicrophone
• CallMuteMicrophone
• CallMuteSpeaker
• CallOutgoing
• CallPlaying
• CallRecording
• CallRemoteAddress
• CallRemotePort
• CallRemoteURI
• CallRemoteUser
• CallSpeaker
• CallStartedAt
• CallState
• CallUserInput
• CallVia

The array indices start at 0 and end at CallCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

CallCallId Property (IVR Class)

String representation of an immutable universally unique identifier (UUID) specific to the call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCallCallId(int iCallIndex);

Unicode (Windows)
LPWSTR GetCallCallId(INT iCallIndex);

char* ipworksvoip_ivr_getcallcallid(void* lpObj, int callindex);

QString GetCallCallId(int iCallIndex);

Default Value

""

Remarks

String representation of an immutable universally unique identifier (UUID) specific to the call.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallConferenceId Property (IVR Class)

A unique identifier for a conference call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCallConferenceId(int iCallIndex);

Unicode (Windows)
LPWSTR GetCallConferenceId(INT iCallIndex);

char* ipworksvoip_ivr_getcallconferenceid(void* lpObj, int callindex);

QString GetCallConferenceId(int iCallIndex);

Default Value

""

Remarks

A unique identifier for a conference call.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallDuration Property (IVR Class)

Elapsed time, in seconds, since the call has begun.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCallDuration(int iCallIndex);

Unicode (Windows)
INT GetCallDuration(INT iCallIndex);

int ipworksvoip_ivr_getcallduration(void* lpObj, int callindex);

int GetCallDuration(int iCallIndex);

Default Value

0

Remarks

Elapsed time, in seconds, since the call has begun. Calculated using the value in CallStartedAt.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Integer

CallLastStatus Property (IVR Class)

This property indicates the call's last response code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCallLastStatus(int iCallIndex);

Unicode (Windows)
INT GetCallLastStatus(INT iCallIndex);

int ipworksvoip_ivr_getcalllaststatus(void* lpObj, int callindex);

int GetCallLastStatus(int iCallIndex);

Default Value

0

Remarks

This field indicates the call's last response code. Response codes are defined in RFC 3261.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Integer

CallLocalAddress Property (IVR Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCallLocalAddress(int iCallIndex);

Unicode (Windows)
LPWSTR GetCallLocalAddress(INT iCallIndex);

char* ipworksvoip_ivr_getcalllocaladdress(void* lpObj, int callindex);

QString GetCallLocalAddress(int iCallIndex);

Default Value

""

Remarks

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallLocalPort Property (IVR Class)

The UDP port in the local host where UDP binds.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCallLocalPort(int iCallIndex);

Unicode (Windows)
INT GetCallLocalPort(INT iCallIndex);

int ipworksvoip_ivr_getcalllocalport(void* lpObj, int callindex);

int GetCallLocalPort(int iCallIndex);

Default Value

0

Remarks

The UDP port in the local host where UDP binds.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Integer

CallMicrophone Property (IVR Class)

The microphone currently in use during the call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCallMicrophone(int iCallIndex);

Unicode (Windows)
LPWSTR GetCallMicrophone(INT iCallIndex);

char* ipworksvoip_ivr_getcallmicrophone(void* lpObj, int callindex);

QString GetCallMicrophone(int iCallIndex);

Default Value

""

Remarks

The microphone currently in use during the call. Set through SetMicrophone.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallMuteMicrophone Property (IVR Class)

This property can be set to mute the Microphone being used by the class in the given call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCallMuteMicrophone(int iCallIndex);
int SetCallMuteMicrophone(int iCallIndex, int bCallMuteMicrophone);

Unicode (Windows)
BOOL GetCallMuteMicrophone(INT iCallIndex);
INT SetCallMuteMicrophone(INT iCallIndex, BOOL bCallMuteMicrophone);

int ipworksvoip_ivr_getcallmutemicrophone(void* lpObj, int callindex);
int ipworksvoip_ivr_setcallmutemicrophone(void* lpObj, int callindex, int bCallMuteMicrophone);

bool GetCallMuteMicrophone(int iCallIndex);
int SetCallMuteMicrophone(int iCallIndex, bool bCallMuteMicrophone);

Default Value

FALSE

Remarks

This field can be set to mute the CallMicrophone being used by the class in the given call. When True, the CallMicrophone is muted.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is not available at design time.

Data Type

Boolean

CallMuteSpeaker Property (IVR Class)

This property can be set to mute the Speaker being used by the class in the given call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCallMuteSpeaker(int iCallIndex);
int SetCallMuteSpeaker(int iCallIndex, int bCallMuteSpeaker);

Unicode (Windows)
BOOL GetCallMuteSpeaker(INT iCallIndex);
INT SetCallMuteSpeaker(INT iCallIndex, BOOL bCallMuteSpeaker);

int ipworksvoip_ivr_getcallmutespeaker(void* lpObj, int callindex);
int ipworksvoip_ivr_setcallmutespeaker(void* lpObj, int callindex, int bCallMuteSpeaker);

bool GetCallMuteSpeaker(int iCallIndex);
int SetCallMuteSpeaker(int iCallIndex, bool bCallMuteSpeaker);

Default Value

FALSE

Remarks

This field can be set to mute the CallSpeaker being used by the class in the given call. When True, the CallSpeaker is muted.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is not available at design time.

Data Type

Boolean

CallOutgoing Property (IVR Class)

Indicates whether the current call is outgoing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCallOutgoing(int iCallIndex);

Unicode (Windows)
BOOL GetCallOutgoing(INT iCallIndex);

int ipworksvoip_ivr_getcalloutgoing(void* lpObj, int callindex);

bool GetCallOutgoing(int iCallIndex);

Default Value

FALSE

Remarks

Indicates whether the current call is outgoing. If false, the call is incoming.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Boolean

CallPlaying Property (IVR Class)

Indicates whether the current call is playing audio via PlayText or PlayFile , or PlayBytes .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCallPlaying(int iCallIndex);

Unicode (Windows)
BOOL GetCallPlaying(INT iCallIndex);

int ipworksvoip_ivr_getcallplaying(void* lpObj, int callindex);

bool GetCallPlaying(int iCallIndex);

Default Value

FALSE

Remarks

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.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Boolean

CallRecording Property (IVR Class)

Indicates whether the current call is recording the received voice from the peer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCallRecording(int iCallIndex);

Unicode (Windows)
BOOL GetCallRecording(INT iCallIndex);

int ipworksvoip_ivr_getcallrecording(void* lpObj, int callindex);

bool GetCallRecording(int iCallIndex);

Default Value

FALSE

Remarks

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.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Boolean

CallRemoteAddress Property (IVR Class)

The address of the remote host we are communicating with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCallRemoteAddress(int iCallIndex);

Unicode (Windows)
LPWSTR GetCallRemoteAddress(INT iCallIndex);

char* ipworksvoip_ivr_getcallremoteaddress(void* lpObj, int callindex);

QString GetCallRemoteAddress(int iCallIndex);

Default Value

""

Remarks

The address of the remote host we are communicating with.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallRemotePort Property (IVR Class)

The port of the remote host we are communicating with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCallRemotePort(int iCallIndex);

Unicode (Windows)
INT GetCallRemotePort(INT iCallIndex);

int ipworksvoip_ivr_getcallremoteport(void* lpObj, int callindex);

int GetCallRemotePort(int iCallIndex);

Default Value

0

Remarks

The port of the remote host we are communicating with. This field is typically 5060.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Integer

CallRemoteURI Property (IVR Class)

This property communicates who to call via SIP.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCallRemoteURI(int iCallIndex);

Unicode (Windows)
LPWSTR GetCallRemoteURI(INT iCallIndex);

char* ipworksvoip_ivr_getcallremoteuri(void* lpObj, int callindex);

QString GetCallRemoteURI(int iCallIndex);

Default Value

""

Remarks

This field communicates who to call via SIP. This value contains the CallRemoteUser, CallRemoteAddress, and the CallRemotePort, and has the following format:

sip:user@host:port

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallRemoteUser Property (IVR Class)

The username or telephone number of the remote user associated with the call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCallRemoteUser(int iCallIndex);

Unicode (Windows)
LPWSTR GetCallRemoteUser(INT iCallIndex);

char* ipworksvoip_ivr_getcallremoteuser(void* lpObj, int callindex);

QString GetCallRemoteUser(int iCallIndex);

Default Value

""

Remarks

The username or telephone number of the remote user associated with the call.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallSpeaker Property (IVR Class)

The speaker currently in use during the call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCallSpeaker(int iCallIndex);

Unicode (Windows)
LPWSTR GetCallSpeaker(INT iCallIndex);

char* ipworksvoip_ivr_getcallspeaker(void* lpObj, int callindex);

QString GetCallSpeaker(int iCallIndex);

Default Value

""

Remarks

The speaker currently in use during the call. Set through SetSpeaker.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallStartedAt Property (IVR Class)

The number of milliseconds since 12:00:00 AM January 1, 1970 when this call started.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCallStartedAt(int iCallIndex);

Unicode (Windows)
LONG64 GetCallStartedAt(INT iCallIndex);

int64 ipworksvoip_ivr_getcallstartedat(void* lpObj, int callindex);

qint64 GetCallStartedAt(int iCallIndex);

Default Value

0

Remarks

The number of milliseconds since 12:00:00 AM January 1, 1970 when this call started.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Long64

CallState Property (IVR Class)

This property indicates the state of the current call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCallState(int iCallIndex);

Unicode (Windows)
INT GetCallState(INT iCallIndex);

CS_INACTIVE(0), 
CS_CONNECTING(1), 
CS_AUT_CONNECTING(2), 
CS_RINGING(3), 
CS_ACTIVE(4), 
CS_ACTIVE_IN_CONFERENCE(5), 
CS_DISCONNECTING(6), 
CS_AUT_DISCONNECTING(7), 
CS_HOLDING(8), 
CS_ON_HOLD(9), 
CS_UNHOLDING(10), 
CS_TRANSFERRING(11), 
CS_AUT_TRANSFERRING(12)

    

int ipworksvoip_ivr_getcallstate(void* lpObj, int callindex);

int GetCallState(int iCallIndex);

Default Value

0

Remarks

This property indicates the state of the current call. The applicable values are as follows:

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

Integer

CallUserInput Property (IVR Class)

String representation of digits typed by the callee using their keypad.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCallUserInput(int iCallIndex);

Unicode (Windows)
LPWSTR GetCallUserInput(INT iCallIndex);

char* ipworksvoip_ivr_getcalluserinput(void* lpObj, int callindex);

QString GetCallUserInput(int iCallIndex);

Default Value

""

Remarks

String representation of digits typed by the callee using their keypad.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

CallVia Property (IVR Class)

The Via header sent in the most recent SIP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCallVia(int iCallIndex);

Unicode (Windows)
LPWSTR GetCallVia(INT iCallIndex);

char* ipworksvoip_ivr_getcallvia(void* lpObj, int callindex);

QString GetCallVia(int iCallIndex);

Default Value

""

Remarks

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.

The CallIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CallCount property.

This property is read-only and not available at design time.

Data Type

String

LocalHost Property (IVR Class)

This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksvoip_ivr_getlocalhost(void* lpObj);
int ipworksvoip_ivr_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class 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 multihomed 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.

Data Type

String

LocalPort Property (IVR Class)

This property includes the User Datagram Protocol (UDP) port in the local host where UDP binds.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);

int ipworksvoip_ivr_getlocalport(void* lpObj);
int ipworksvoip_ivr_setlocalport(void* lpObj, int iLocalPort);

int GetLocalPort();
int SetLocalPort(int iLocalPort);

Default Value

0

Remarks

The LocalPort property must be set before UDP is activated (Active is set to True). This instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting it to 0 (default) enables the Transmission Control Protocol (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 class is Active. Any attempt to set the LocalPort property when the class is Active will generate an error.

The LocalPort property is useful when trying to connect to services that require a trusted port on the client side.

Data Type

Integer

Password Property (IVR Class)

The password that is used when connecting to the SIP Server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworksvoip_ivr_getpassword(void* lpObj);
int ipworksvoip_ivr_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

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 class via Activate.

This property is not available at design time.

Data Type

String

Port Property (IVR Class)

The port on the SIP server the class is connecting to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPort();
int SetPort(int iPort);

Unicode (Windows)
INT GetPort();
INT SetPort(INT iPort);

int ipworksvoip_ivr_getport(void* lpObj);
int ipworksvoip_ivr_setport(void* lpObj, int iPort);

int GetPort();
int SetPort(int iPort);

Default Value

5060

Remarks

This property specifies the port on the SIP server that the class will connect to. This value will be used when activating the class via Activate.

Data Type

Integer

RTPSecurityMode Property (IVR Class)

Specifies the security mode that will be used when transmitting RTP.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRTPSecurityMode();
int SetRTPSecurityMode(int iRTPSecurityMode);

Unicode (Windows)
INT GetRTPSecurityMode();
INT SetRTPSecurityMode(INT iRTPSecurityMode);

ET_NONE(0), 
ET_SDES(1), 
ET_DTLS(2)

    

int ipworksvoip_ivr_getrtpsecuritymode(void* lpObj);
int ipworksvoip_ivr_setrtpsecuritymode(void* lpObj, int iRTPSecurityMode);

int GetRTPSecurityMode();
int SetRTPSecurityMode(int iRTPSecurityMode);

Default Value

0

Remarks

This property is used to specify the security mode that will be used when transmitting RTP (audio data). Possible modes are:

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.

Data Type

Integer

Server Property (IVR Class)

The address of the SIP Server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServer();
int SetServer(const char* lpszServer);

Unicode (Windows)
LPWSTR GetServer();
INT SetServer(LPCWSTR lpszServer);

char* ipworksvoip_ivr_getserver(void* lpObj);
int ipworksvoip_ivr_setserver(void* lpObj, const char* lpszServer);

QString GetServer();
int SetServer(QString qsServer);

Default Value

""

Remarks

This property contains the address of the SIP Server the class will attempt to connect to. This value will be used when activating the class via Activate.

Data Type

String

SIPTransportProtocol Property (IVR Class)

Specifies the transport protocol the class will use for SIP signaling.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSIPTransportProtocol();
int SetSIPTransportProtocol(int iSIPTransportProtocol);

Unicode (Windows)
INT GetSIPTransportProtocol();
INT SetSIPTransportProtocol(INT iSIPTransportProtocol);

TP_UDP(0), 
TP_TCP(1), 
TP_TLS(2)

    

int ipworksvoip_ivr_getsiptransportprotocol(void* lpObj);
int ipworksvoip_ivr_setsiptransportprotocol(void* lpObj, int iSIPTransportProtocol);

int GetSIPTransportProtocol();
int SetSIPTransportProtocol(int iSIPTransportProtocol);

Default Value

0

Remarks

This property specifies which transport protocol (UDP, TCP, TLS) the class 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:

Note when TLS is specified, the Port will typically need to be set to 5061.

Data Type

Integer

SSLAcceptServerCertEncoded Property (IVR Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int ipworksvoip_ivr_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksvoip_ivr_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (IVR Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworksvoip_ivr_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksvoip_ivr_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (IVR Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworksvoip_ivr_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksvoip_ivr_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

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.

Data Type

Binary String

SSLCertStorePassword Property (IVR Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworksvoip_ivr_getsslcertstorepassword(void* lpObj);
int ipworksvoip_ivr_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

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.

Data Type

String

SSLCertStoreType Property (IVR Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

    

int ipworksvoip_ivr_getsslcertstoretype(void* lpObj);
int ipworksvoip_ivr_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is not available at design time.

Data Type

Integer

SSLCertSubject Property (IVR Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworksvoip_ivr_getsslcertsubject(void* lpObj);
int ipworksvoip_ivr_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

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, or E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is not available at design time.

Data Type

String

User Property (IVR Class)

The username that is used when connecting to the SIP Server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworksvoip_ivr_getuser(void* lpObj);
int ipworksvoip_ivr_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

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 class via Activate.

This property is not available at design time.

Data Type

String

Activate Method (IVR Class)

Activates the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Activate();

Unicode (Windows)
INT Activate();

int ipworksvoip_ivr_activate(void* lpObj);

int Activate();

Remarks

This method is used to activate the class 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Answer Method (IVR Class)

Answers an incoming phone call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Answer(const char* lpszcallId);

Unicode (Windows)
INT Answer(LPCWSTR lpszcallId);

int ipworksvoip_ivr_answer(void* lpObj, const char* lpszcallId);

int Answer(const QString& qscallId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (IVR Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksvoip_ivr_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Deactivate Method (IVR Class)

Deactivates the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Deactivate();

Unicode (Windows)
INT Deactivate();

int ipworksvoip_ivr_deactivate(void* lpObj);

int Deactivate();

Remarks

This method is used to unregister the class from the SIP Server. If deactivation is successful, Deactivated will fire.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Decline Method (IVR Class)

Declines an incoming phone call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decline(const char* lpszcallId);

Unicode (Windows)
INT Decline(LPCWSTR lpszcallId);

int ipworksvoip_ivr_decline(void* lpObj, const char* lpszcallId);

int Decline(const QString& qscallId);

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); };

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Dial Method (IVR Class)

Used to make a call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Dial(const char* lpsznumber, const char* lpszcallerNumber, int bwait);

Unicode (Windows)
LPWSTR Dial(LPCWSTR lpsznumber, LPCWSTR lpszcallerNumber, BOOL bwait);

char* ipworksvoip_ivr_dial(void* lpObj, const char* lpsznumber, const char* lpszcallerNumber, int bwait);

QString Dial(const QString& qsnumber, const QString& qscallerNumber, bool bwait);

Remarks

This method is used to make a call to a particular user, given by Number. This method should only be called after the class 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 class 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 class should connect synchronously or asynchronously to the call. If True, the class will connect synchronously, and won't return until the call has been answered, declined, or ignored. If False, the class 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 class 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"); }

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoEvents Method (IVR Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksvoip_ivr_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Hangup Method (IVR Class)

Used to hang up a specific call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Hangup(const char* lpszcallId);

Unicode (Windows)
INT Hangup(LPCWSTR lpszcallId);

int ipworksvoip_ivr_hangup(void* lpObj, const char* lpszcallId);

int Hangup(const QString& qscallId);

Remarks

This method is used to terminate a specific call, specified by CallId. After the call has been successfully terminated, CallTerminated will fire.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

HangupAll Method (IVR Class)

Used to hang up all calls.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int HangupAll();

Unicode (Windows)
INT HangupAll();

int ipworksvoip_ivr_hangupall(void* lpObj);

int HangupAll();

Remarks

This method is used to terminate all calls currently in the Call* properties. CallTerminated will fire for each successfully terminated call.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Hold Method (IVR Class)

Places a call on hold.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Hold(const char* lpszcallId);

Unicode (Windows)
INT Hold(LPCWSTR lpszcallId);

int ipworksvoip_ivr_hold(void* lpObj, const char* lpszcallId);

int Hold(const QString& qscallId);

Remarks

This method is used to place a call, specified by CallId, on hold.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Ping Method (IVR Class)

Used to ping the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Ping(int itimeout);

Unicode (Windows)
INT Ping(INT itimeout);

int ipworksvoip_ivr_ping(void* lpObj, int itimeout);

int Ping(int itimeout);

Remarks

This method is used to ping the SIP server by sending an OPTIONS request. If no server response is received by the class in Timeout seconds, Ping will throw an error.

Note this method is only applicable when the component is active.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

PlayBytes Method (IVR Class)

This method is used to play bytes to a call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PlayBytes(const char* lpszcallId, const char* lpbytesToPlay, int lenbytesToPlay, int blastBlock);

Unicode (Windows)
INT PlayBytes(LPCWSTR lpszcallId, LPCSTR lpbytesToPlay, INT lenbytesToPlay, BOOL blastBlock);

int ipworksvoip_ivr_playbytes(void* lpObj, const char* lpszcallId, const char* lpbytesToPlay, int lenbytesToPlay, int blastBlock);

int PlayBytes(const QString& qscallId, QByteArray qbabytesToPlay, bool blastBlock);

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 class 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 class will be considered to be playing audio.

If LastBlock is false, this indicates that the class 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 }

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

PlayFile Method (IVR Class)

Plays audio from a WAV file to a call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PlayFile(const char* lpszcallId, const char* lpszwavFile);

Unicode (Windows)
INT PlayFile(LPCWSTR lpszcallId, LPCWSTR lpszwavFile);

int ipworksvoip_ivr_playfile(void* lpObj, const char* lpszcallId, const char* lpszwavFile);

int PlayFile(const QString& qscallId, const QString& qswavFile);

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 class 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

PlayText Method (IVR Class)

Plays audio from a string to a call using Text-to-Speech.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PlayText(const char* lpszcallId, const char* lpsztext);

Unicode (Windows)
INT PlayText(LPCWSTR lpszcallId, LPCWSTR lpsztext);

int ipworksvoip_ivr_playtext(void* lpObj, const char* lpszcallId, const char* lpsztext);

int PlayText(const QString& qscallId, const QString& qstext);

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 class 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (IVR Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksvoip_ivr_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StartRecording Method (IVR Class)

Used to start recording the audio of a call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartRecording(const char* lpszcallId, const char* lpszfilename);

Unicode (Windows)
INT StartRecording(LPCWSTR lpszcallId, LPCWSTR lpszfilename);

int ipworksvoip_ivr_startrecording(void* lpObj, const char* lpszcallId, const char* lpszfilename);

int StartRecording(const QString& qscallId, const QString& qsfilename);

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()); };

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StopPlaying Method (IVR Class)

Stops audio from playing to a call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StopPlaying(const char* lpszcallId);

Unicode (Windows)
INT StopPlaying(LPCWSTR lpszcallId);

int ipworksvoip_ivr_stopplaying(void* lpObj, const char* lpszcallId);

int StopPlaying(const QString& qscallId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StopRecording Method (IVR Class)

Stops recording the audio of a call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StopRecording(const char* lpszcallId);

Unicode (Windows)
INT StopRecording(LPCWSTR lpszcallId);

int ipworksvoip_ivr_stoprecording(void* lpObj, const char* lpszcallId);

int StopRecording(const QString& qscallId);

Remarks

This method is used to stop recording the audio of a call, given by CallId. The class will automatically stop recording upon call termination.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Transfer Method (IVR Class)

Transfers a call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Transfer(const char* lpszcallId, const char* lpsznumber);

Unicode (Windows)
INT Transfer(LPCWSTR lpszcallId, LPCWSTR lpsznumber);

int ipworksvoip_ivr_transfer(void* lpObj, const char* lpszcallId, const char* lpsznumber);

int Transfer(const QString& qscallId, const QString& qsnumber);

Remarks

This method is used to transfer a call, specified by CallId, to the phone number given by Number. The class 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 class 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Unhold Method (IVR Class)

Takes a call off hold.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Unhold(const char* lpszcallId);

Unicode (Windows)
INT Unhold(LPCWSTR lpszcallId);

int ipworksvoip_ivr_unhold(void* lpObj, const char* lpszcallId);

int Unhold(const QString& qscallId);

Remarks

This method is used to take a call, specified by CallId, off hold.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Activated Event (IVR Class)

This event is fired immediately after the class is activated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireActivated(IVRActivatedEventParams *e);

typedef struct {
  int reserved;
} IVRActivatedEventParams;


Unicode (Windows)
virtual INT FireActivated(IVRActivatedEventParams *e);

typedef struct {
  INT reserved;
} IVRActivatedEventParams;

#define EID_IVR_ACTIVATED 1

virtual INT IPWORKSVOIP_CALL FireActivated();

class IVRActivatedEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Activated(IVRActivatedEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FireActivated(IVRActivatedEventParams *e) {...}

Remarks

The Activated event will fire after the class has successfully registered with the SIP Server via Activate.

CallReady Event (IVR Class)

This event is fired after a call has been answered, declined, or ignored.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCallReady(IVRCallReadyEventParams *e);

typedef struct {
  const char *CallId;
  int reserved;
} IVRCallReadyEventParams;


Unicode (Windows)
virtual INT FireCallReady(IVRCallReadyEventParams *e);

typedef struct {
  LPCWSTR CallId;
  INT reserved;
} IVRCallReadyEventParams;

#define EID_IVR_CALLREADY 2

virtual INT IPWORKSVOIP_CALL FireCallReady(LPSTR &lpszCallId);

class IVRCallReadyEventParams {
public:
  const QString &CallId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CallReady(IVRCallReadyEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FireCallReady(IVRCallReadyEventParams *e) {...}

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 class 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 Id of the call.

CallStateChanged Event (IVR Class)

This event is fired after a call's state has changed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCallStateChanged(IVRCallStateChangedEventParams *e);

typedef struct {
  const char *CallId;
  int State;
  int reserved;
} IVRCallStateChangedEventParams;


Unicode (Windows)
virtual INT FireCallStateChanged(IVRCallStateChangedEventParams *e);

typedef struct {
  LPCWSTR CallId;
  INT State;
  INT reserved;
} IVRCallStateChangedEventParams;

#define EID_IVR_CALLSTATECHANGED 3

virtual INT IPWORKSVOIP_CALL FireCallStateChanged(LPSTR &lpszCallId, INT &iState);

class IVRCallStateChangedEventParams {
public:
  const QString &CallId();

  int State();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CallStateChanged(IVRCallStateChangedEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FireCallStateChanged(IVRCallStateChangedEventParams *e) {...}

Remarks

The CallStateChanged event will fire each time the state of a call has changed.

The CallId parameter is the unique Id of the call.

The State parameter denotes the state the call has changed to. The following values are applicable:

CallTerminated Event (IVR Class)

This event is fired after a call has been terminated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCallTerminated(IVRCallTerminatedEventParams *e);

typedef struct {
  const char *CallId;
  int reserved;
} IVRCallTerminatedEventParams;


Unicode (Windows)
virtual INT FireCallTerminated(IVRCallTerminatedEventParams *e);

typedef struct {
  LPCWSTR CallId;
  INT reserved;
} IVRCallTerminatedEventParams;

#define EID_IVR_CALLTERMINATED 4

virtual INT IPWORKSVOIP_CALL FireCallTerminated(LPSTR &lpszCallId);

class IVRCallTerminatedEventParams {
public:
  const QString &CallId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CallTerminated(IVRCallTerminatedEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FireCallTerminated(IVRCallTerminatedEventParams *e) {...}

Remarks

The CallTerminated event will fire after a call has been terminated by either end of the call.

The CallId parameter is the unique Id of the call.

Deactivated Event (IVR Class)

This event is fired immediately after the class is deactivated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDeactivated(IVRDeactivatedEventParams *e);

typedef struct {
  int reserved;
} IVRDeactivatedEventParams;


Unicode (Windows)
virtual INT FireDeactivated(IVRDeactivatedEventParams *e);

typedef struct {
  INT reserved;
} IVRDeactivatedEventParams;

#define EID_IVR_DEACTIVATED 5

virtual INT IPWORKSVOIP_CALL FireDeactivated();

class IVRDeactivatedEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Deactivated(IVRDeactivatedEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FireDeactivated(IVRDeactivatedEventParams *e) {...}

Remarks

The Deactivated event will fire after the class has unregistered from the SIP Server via Deactivate.

DialCompleted Event (IVR Class)

This event is fired after the dial process has finished.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDialCompleted(IVRDialCompletedEventParams *e);

typedef struct {
  const char *OriginalCallId;
  const char *CallId;
  const char *Caller;
  const char *Callee;
  int ErrorCode;
  const char *Description;
  int reserved;
} IVRDialCompletedEventParams;


Unicode (Windows)
virtual INT FireDialCompleted(IVRDialCompletedEventParams *e);

typedef struct {
  LPCWSTR OriginalCallId;
  LPCWSTR CallId;
  LPCWSTR Caller;
  LPCWSTR Callee;
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} IVRDialCompletedEventParams;

#define EID_IVR_DIALCOMPLETED 6

virtual INT IPWORKSVOIP_CALL FireDialCompleted(LPSTR &lpszOriginalCallId, LPSTR &lpszCallId, LPSTR &lpszCaller, LPSTR &lpszCallee, INT &iErrorCode, LPSTR &lpszDescription);

class IVRDialCompletedEventParams {
public:
  const QString &OriginalCallId();

  const QString &CallId();

  const QString &Caller();

  const QString &Callee();

  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DialCompleted(IVRDialCompletedEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FireDialCompleted(IVRDialCompletedEventParams *e) {...}

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 class 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:

1. The outgoing call has not been redirected. In this case, CallId is equal to OriginalCallId, and the value returned by Dial is correct.
2. 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 Class)

This event fires every time a digit is pressed using the keypad.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDigit(IVRDigitEventParams *e);

typedef struct {
  const char *CallId;
  const char *Digit;
  int reserved;
} IVRDigitEventParams;


Unicode (Windows)
virtual INT FireDigit(IVRDigitEventParams *e);

typedef struct {
  LPCWSTR CallId;
  LPCWSTR Digit;
  INT reserved;
} IVRDigitEventParams;

#define EID_IVR_DIGIT 7

virtual INT IPWORKSVOIP_CALL FireDigit(LPSTR &lpszCallId, LPSTR &lpszDigit);

class IVRDigitEventParams {
public:
  const QString &CallId();

  const QString &Digit();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Digit(IVRDigitEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FireDigit(IVRDigitEventParams *e) {...}

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 class's inputs via TypeDigit. Detectable inputs include: 0-9, *, #

The CallId parameter is the unique Id of the call.

Error Event (IVR Class)

This event is fired for information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(IVRErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} IVRErrorEventParams;


Unicode (Windows)
virtual INT FireError(IVRErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} IVRErrorEventParams;

#define EID_IVR_ERROR 8

virtual INT IPWORKSVOIP_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class IVRErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(IVRErrorEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FireError(IVRErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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 Class)

This event is fired when there's an incoming call.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireIncomingCall(IVRIncomingCallEventParams *e);

typedef struct {
  const char *CallId;
  const char *RemoteUser;
  int reserved;
} IVRIncomingCallEventParams;


Unicode (Windows)
virtual INT FireIncomingCall(IVRIncomingCallEventParams *e);

typedef struct {
  LPCWSTR CallId;
  LPCWSTR RemoteUser;
  INT reserved;
} IVRIncomingCallEventParams;

#define EID_IVR_INCOMINGCALL 9

virtual INT IPWORKSVOIP_CALL FireIncomingCall(LPSTR &lpszCallId, LPSTR &lpszRemoteUser);

class IVRIncomingCallEventParams {
public:
  const QString &CallId();

  const QString &RemoteUser();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void IncomingCall(IVRIncomingCallEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FireIncomingCall(IVRIncomingCallEventParams *e) {...}

Remarks

The IncomingCall event will fire after an incoming call is detected.

The CallId parameter specifies the unique 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 Class)

This event is fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(IVRLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} IVRLogEventParams;


Unicode (Windows)
virtual INT FireLog(IVRLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} IVRLogEventParams;

#define EID_IVR_LOG 10

virtual INT IPWORKSVOIP_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class IVRLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(IVRLogEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FireLog(IVRLogEventParams *e) {...}

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel configuration.

LogLevel indicates the detail level of the message. Possible values are:

Message is the log message.

LogType identifies the type of log entry. Possible values are as follows:

• Info
• Packet
• RTP

OutgoingCall Event (IVR Class)

This event is fired when an outgoing call has been made.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireOutgoingCall(IVROutgoingCallEventParams *e);

typedef struct {
  const char *CallId;
  const char *RemoteUser;
  int reserved;
} IVROutgoingCallEventParams;


Unicode (Windows)
virtual INT FireOutgoingCall(IVROutgoingCallEventParams *e);

typedef struct {
  LPCWSTR CallId;
  LPCWSTR RemoteUser;
  INT reserved;
} IVROutgoingCallEventParams;

#define EID_IVR_OUTGOINGCALL 11

virtual INT IPWORKSVOIP_CALL FireOutgoingCall(LPSTR &lpszCallId, LPSTR &lpszRemoteUser);

class IVROutgoingCallEventParams {
public:
  const QString &CallId();

  const QString &RemoteUser();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void OutgoingCall(IVROutgoingCallEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FireOutgoingCall(IVROutgoingCallEventParams *e) {...}

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 Id of the call.

The RemoteUser parameter indicates the username or telephone number of the remote user associated with the call.

Played Event (IVR Class)

This event is fired after the class finishes playing available audio.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePlayed(IVRPlayedEventParams *e);

typedef struct {
  const char *CallId;
  int Completed;
  int reserved;
} IVRPlayedEventParams;


Unicode (Windows)
virtual INT FirePlayed(IVRPlayedEventParams *e);

typedef struct {
  LPCWSTR CallId;
  BOOL Completed;
  INT reserved;
} IVRPlayedEventParams;

#define EID_IVR_PLAYED 12

virtual INT IPWORKSVOIP_CALL FirePlayed(LPSTR &lpszCallId, BOOL &bCompleted);

class IVRPlayedEventParams {
public:
  const QString &CallId();

  bool Completed();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Played(IVRPlayedEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FirePlayed(IVRPlayedEventParams *e) {...}

Remarks

The Played event will fire after the class 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 class 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 class 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 Id of the call.

Record Event (IVR Class)

This event is fired when recorded audio data is available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRecord(IVRRecordEventParams *e);

typedef struct {
  const char *CallId;
  const char *RecordedData;
  int lenRecordedData;
  int reserved;
} IVRRecordEventParams;


Unicode (Windows)
virtual INT FireRecord(IVRRecordEventParams *e);

typedef struct {
  LPCWSTR CallId;
  LPCSTR RecordedData;
  INT lenRecordedData;
  INT reserved;
} IVRRecordEventParams;

#define EID_IVR_RECORD 13

virtual INT IPWORKSVOIP_CALL FireRecord(LPSTR &lpszCallId, LPSTR &lpRecordedData, INT &lenRecordedData);

class IVRRecordEventParams {
public:
  const QString &CallId();

  const QByteArray &RecordedData();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Record(IVRRecordEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FireRecord(IVRRecordEventParams *e) {...}

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 Id of the call.

Silence Event (IVR Class)

This event is fired when the class detects silence from incoming audio streams.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSilence(IVRSilenceEventParams *e);

typedef struct {
  const char *CallId;
  int reserved;
} IVRSilenceEventParams;


Unicode (Windows)
virtual INT FireSilence(IVRSilenceEventParams *e);

typedef struct {
  LPCWSTR CallId;
  INT reserved;
} IVRSilenceEventParams;

#define EID_IVR_SILENCE 14

virtual INT IPWORKSVOIP_CALL FireSilence(LPSTR &lpszCallId);

class IVRSilenceEventParams {
public:
  const QString &CallId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Silence(IVRSilenceEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FireSilence(IVRSilenceEventParams *e) {...}

Remarks

The Silence event will fire every second the class 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 Id of the call.

SSLServerAuthentication Event (IVR Class)

This event is fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(IVRSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} IVRSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(IVRSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} IVRSSLServerAuthenticationEventParams;

#define EID_IVR_SSLSERVERAUTHENTICATION 15

virtual INT IPWORKSVOIP_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class IVRSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(IVRSSLServerAuthenticationEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FireSSLServerAuthentication(IVRSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. 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 or not to continue.

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 Class)

This event shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(IVRSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} IVRSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(IVRSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} IVRSSLStatusEventParams;

#define EID_IVR_SSLSTATUS 16

virtual INT IPWORKSVOIP_CALL FireSSLStatus(LPSTR &lpszMessage);

class IVRSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(IVRSSLStatusEventParams *e);

// Or, subclass IVR and override this emitter function.
virtual int FireSSLStatus(IVRSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks 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

Constructors

Call()

Config Settings (IVR Class)

IPPhone Config Settings

Base Config Settings

Trappable Errors (IVR Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

IPPHONE Errors

UDP Errors

SSL Errors

TCP/IP Errors