IPPhone Class

Properties   Methods   Events   Config Settings   Errors  

The IPPhone class can be used to implement a software-based phone.

Syntax

class ipworksvoip.IPPhone

Remarks

The IPPhone class can be used to implement a software-based phone utilizing modern Voice over Internet Protocol (VoIP) technology. This softphone is able to perform many different functions of a traditional telephone, such as making and receiving calls, performing blind and attended transfers, placing calls on hold, establishing and joining conferences, and more.

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 on_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 do_events, when needed. To ensure this occurs, we recommend calling do_events 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 do_events 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 sip_transport_protocol property must be set to 2 (TLS). The port property will typically need to be set to 5061 (this may vary). Additionally, the on_ssl_server_authentication 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 on_ssl_status event with the prefix [SIP TLS].

Enable SRTP

While the above process secures SIP signaling, it does not secure RTP (audio) communication. The rtp_security_mode 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 rtp_security_mode 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 sip_transport_protocol 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.

Audio Setup

While not required to function, you may set the microphone and speaker for the class to use during calls. First, you must call list_microphones and list_speakers. Doing so will populate the Microphone* properties and the Speaker* properties. Once this is done, you can set these devices via set_microphone and set_speaker given their device name. For example:

ipphone1.ListMicrophones(); ipphone1.ListSpeakers(); foreach (Speaker s in ipphone1.Speakers) { Console.WriteLine("Speaker Name: " + s.Name); } foreach (Microphone m in ipphone1.Microphones) { Console.WriteLine("Microphone Name: " + m.Name); } ipphone1.SetSpeaker(ipphone1.Speakers[0].Name); ipphone1.SetMicrophone(ipphone1.Microphones[0].Name);

Managing Calls

All incoming and outgoing calls currently recognized by the class will be stored in the Call* properties. These connections will be initiated or accepted through the interface identified by local_host and local_port.

Incoming Calls

After successful activation, incoming calls will be detected, and on_incoming_call will fire for each call. Within this event, answer, decline, or forward can be used to handle these calls. For example:

ipphone1.OnIncomingCall += (o, e) => { ipphone1.Answer(e.CallId); };

Outgoing Calls

To make an outgoing call, you must use dial. This method takes three parameters: the user you wish to call, your caller ID (optional), and a boolean that determines whether the method will connect synchronously (True) or asynchronously (False). If set, the second parameter will cause P-Asserted-Identity headers (RFC 3325) to be sent in requests to the server. If left as an empty string, this header will not be sent. dial will return a call identification string (Call-ID) that is unique to the call. After the method returns successfully, the call will be added to the Call* properties.

Please see the method description for detailed examples on using dial synchronously and asynchronously.

Transferring Calls

Ongoing calls can be transferred using transfer. The class supports two types of transfers:

Basic (Blind) Transfers

Basic transfers are very simple to perform. First, the user establishes 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" they are transferring to (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 calls are active, you may perform an attended transfer by calling transfer at any moment. Afterwards, a session will be established between both calls, 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.

Audio Playback

The class supports three methods of playing audio to a call, being play_file, play_text, or play_bytes. Note for each of these methods, audio transmission will only occur when the call has connected and on_call_ready has fired. Additionally, 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). Also note that these methods are non-blocking, and will return immediately. The class can also handle playing audio to concurrent calls.

play_file can be used to play audio from a WAV file to a specific call. play_text can also be used to play audio, but will do so using Text-to-Speech. Once audio has finished playing, on_played will fire.

play_bytes can be used to play audio, but will do so in an event-based manner. The behavior of play_bytes is very different from the previous two methods. For a detailed description on how to use this method with the on_played event, please see the method and event descriptions.

Recording Audio

Ongoing calls can be recorded using start_recording. The audio can be recorded directly to a WAV file by specifying the filename parameter. Additionally, if the filename parameter is not specified, the audio will be recorded internally, and made available once the recording is finished. The recorded data will be available within the on_record event.

Note in both scenarios, the recording will end either when the call is terminated, or stop_recording is called. 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()); };

Conferencing

The class also supports conferencing. A call can join a conference using the join_conference method, passing in the callId of the call and the custom conferenceId. If the conferenceId does not exist, then a new conference will be created given this ID. Other calls can then join the existing conference with this same ID.

To monitor existing conferences, the list_conferences method will return a string containing all ongoing conferences and calls within each conference. This value will have the following format:

ConferenceId_1: CallId_1, CallId_2

...

ConferenceId_n: CallId_3, CallId_4, CallId_5, ...

At any moment, a call can be removed from a conference using leave_conference. If the user is the last call within the conference, then the conference will be removed.

Call Termination

Ongoing calls are terminated by passing the appropriate Call-ID to hangup. All ongoing calls can be terminated with hangup_all. When a call has been terminated (by either party), on_call_terminated will fire. It's important to note that in the case where an outgoing call is never answered, the class will attempt to leave a voicemail. The voicemail will end once hangup or hangup_all is called, and on_call_terminated 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

The current activation status of the class.

Syntax

def get_active() -> bool: ...

active = property(get_active, None)

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.

call_count Property

The number of records in the Call arrays.

Syntax

def get_call_count() -> int: ...

call_count = property(get_call_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• call_call_id
• call_conference_id
• call_duration
• call_last_status
• call_local_address
• call_local_port
• call_microphone
• call_mute_microphone
• call_mute_speaker
• call_outgoing
• call_playing
• call_recording
• call_remote_address
• call_remote_port
• call_remote_uri
• call_remote_user
• call_speaker
• call_started_at
• call_state
• call_user_input
• call_via

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

This property is read-only.

call_call_id Property

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

Syntax

def get_call_call_id(call_index: int) -> str: ...

Default Value

""

Remarks

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

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_conference_id Property

A unique identifier for a conference call.

Syntax

def get_call_conference_id(call_index: int) -> str: ...

Default Value

""

Remarks

A unique identifier for a conference call.

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_duration Property

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

Syntax

def get_call_duration(call_index: int) -> int: ...

Default Value

0

Remarks

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

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_last_status Property

This property indicates the call's last response code.

Syntax

def get_call_last_status(call_index: int) -> int: ...

Default Value

0

Remarks

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

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_local_address Property

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

Syntax

def get_call_local_address(call_index: int) -> str: ...

Default Value

""

Remarks

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

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_local_port Property

The UDP port in the local host where UDP binds.

Syntax

def get_call_local_port(call_index: int) -> int: ...

Default Value

0

Remarks

The UDP port in the local host where UDP binds.

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_microphone Property

The microphone currently in use during the call.

Syntax

def get_call_microphone(call_index: int) -> str: ...

Default Value

""

Remarks

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

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_mute_microphone Property

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

Syntax

def get_call_mute_microphone(call_index: int) -> bool: ...
def set_call_mute_microphone(call_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

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

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

call_mute_speaker Property

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

Syntax

def get_call_mute_speaker(call_index: int) -> bool: ...
def set_call_mute_speaker(call_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

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

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

call_outgoing Property

Indicates whether the current call is outgoing.

Syntax

def get_call_outgoing(call_index: int) -> bool: ...

Default Value

FALSE

Remarks

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

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_playing Property

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

Syntax

def get_call_playing(call_index: int) -> bool: ...

Default Value

FALSE

Remarks

Indicates whether the current call is playing audio via play_text or play_file, or play_bytes. After audio transmission is complete, or stopped using stop_playing, this flag will be false.

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_recording Property

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

Syntax

def get_call_recording(call_index: int) -> bool: ...

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 stop_recording, this flag will be false.

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_remote_address Property

The address of the remote host we are communicating with.

Syntax

def get_call_remote_address(call_index: int) -> str: ...

Default Value

""

Remarks

The address of the remote host we are communicating with.

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_remote_port Property

The port of the remote host we are communicating with.

Syntax

def get_call_remote_port(call_index: int) -> int: ...

Default Value

0

Remarks

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

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_remote_uri Property

This property communicates who to call via SIP.

Syntax

def get_call_remote_uri(call_index: int) -> str: ...

Default Value

""

Remarks

This field communicates who to call via SIP. This value contains the call_remote_user, call_remote_address, and the call_remote_port, and has the following format:

sip:user@host:port

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_remote_user Property

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

Syntax

def get_call_remote_user(call_index: int) -> str: ...

Default Value

""

Remarks

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

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_speaker Property

The speaker currently in use during the call.

Syntax

def get_call_speaker(call_index: int) -> str: ...

Default Value

""

Remarks

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

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_started_at Property

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

Syntax

def get_call_started_at(call_index: int) -> int: ...

Default Value

0

Remarks

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

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_state Property

This property indicates the state of the current call.

Syntax

def get_call_state(call_index: int) -> int: ...

Default Value

0

Remarks

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

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_user_input Property

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

Syntax

def get_call_user_input(call_index: int) -> str: ...

Default Value

""

Remarks

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

The call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

call_via Property

The Via header sent in the most recent SIP request.

Syntax

def get_call_via(call_index: int) -> str: ...

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 call_index parameter specifies the index of the item in the array. The size of the array is controlled by the call_count property.

This property is read-only.

local_host Property

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

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host 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 class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host 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: local_host is not persistent. You must always set it in code, and never in the property window.

local_port Property

The UDP port in the local host where UDP binds.

Syntax

def get_local_port() -> int: ...
def set_local_port(value: int) -> None: ...

local_port = property(get_local_port, set_local_port)

Default Value

0

Remarks

The local_port property must be set before UDP is activated (active is set to True). It instructs the class 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 local_port property after the connection is established.

local_port cannot be changed once the class is active. Any attempt to set the local_port property when the class is active will generate an error.

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

microphone_count Property

The number of records in the Microphone arrays.

Syntax

def get_microphone_count() -> int: ...

microphone_count = property(get_microphone_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• microphone_channels
• microphone_manufacturer_id
• microphone_name
• microphone_product_id
• microphone_support
• microphone_supported_formats

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

This property is read-only.

microphone_channels Property

Number specifying whether the device supports mono (1) or stereo (2) output.

Syntax

def get_microphone_channels(microphone_index: int) -> int: ...

Default Value

0

Remarks

Number specifying whether the device supports mono (1) or stereo (2) output.

The microphone_index parameter specifies the index of the item in the array. The size of the array is controlled by the microphone_count property.

This property is read-only.

microphone_manufacturer_id Property

Manufacturer identifier for the device driver for the device.

Syntax

def get_microphone_manufacturer_id(microphone_index: int) -> int: ...

Default Value

0

Remarks

Manufacturer identifier for the device driver for the device.

The microphone_index parameter specifies the index of the item in the array. The size of the array is controlled by the microphone_count property.

This property is read-only.

microphone_name Property

Product name in a null-terminated string.

Syntax

def get_microphone_name(microphone_index: int) -> str: ...

Default Value

""

Remarks

Product name in a null-terminated string.

The microphone_index parameter specifies the index of the item in the array. The size of the array is controlled by the microphone_count property.

This property is read-only.

microphone_product_id Property

Product identifier for the device as assigned by Windows.

Syntax

def get_microphone_product_id(microphone_index: int) -> int: ...

Default Value

0

Remarks

Product identifier for the device as assigned by Windows.

The microphone_index parameter specifies the index of the item in the array. The size of the array is controlled by the microphone_count property.

This property is read-only.

microphone_support Property

Bitmask of optional functionalities supported by the device.

Syntax

def get_microphone_support(microphone_index: int) -> int: ...

Default Value

0

Remarks

Bitmask of optional functionalities supported by the device. This field can have one or more of the following values OR'd together:

The microphone_index parameter specifies the index of the item in the array. The size of the array is controlled by the microphone_count property.

This property is read-only.

microphone_supported_formats Property

Bitmask of standard formats that are supported.

Syntax

def get_microphone_supported_formats(microphone_index: int) -> int: ...

Default Value

0

Remarks

Bitmask of standard formats that are supported. This field can have one or more of the following values OR'd together:

The microphone_index parameter specifies the index of the item in the array. The size of the array is controlled by the microphone_count property.

This property is read-only.

password Property

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

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, 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 class via activate.

port Property

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

Syntax

def get_port() -> int: ...
def set_port(value: int) -> None: ...

port = property(get_port, set_port)

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.

rtp_security_mode Property

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

Syntax

def get_rtp_security_mode() -> int: ...
def set_rtp_security_mode(value: int) -> None: ...

rtp_security_mode = property(get_rtp_security_mode, set_rtp_security_mode)

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 sip_transport_protocol is set to TLS when enabling SRTP.

server Property

The address of the SIP Server.

Syntax

def get_server() -> str: ...
def set_server(value: str) -> None: ...

server = property(get_server, set_server)

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.

sip_transport_protocol Property

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

Syntax

def get_sip_transport_protocol() -> int: ...
def set_sip_transport_protocol(value: int) -> None: ...

sip_transport_protocol = property(get_sip_transport_protocol, set_sip_transport_protocol)

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

speaker_count Property

The number of records in the Speaker arrays.

Syntax

def get_speaker_count() -> int: ...

speaker_count = property(get_speaker_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• speaker_channels
• speaker_manufacturer_id
• speaker_name
• speaker_product_id
• speaker_support
• speaker_supported_formats

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

This property is read-only.

speaker_channels Property

Number specifying whether the device supports mono (1) or stereo (2) output.

Syntax

def get_speaker_channels(speaker_index: int) -> int: ...

Default Value

0

Remarks

Number specifying whether the device supports mono (1) or stereo (2) output.

The speaker_index parameter specifies the index of the item in the array. The size of the array is controlled by the speaker_count property.

This property is read-only.

speaker_manufacturer_id Property

Manufacturer identifier for the device driver for the device.

Syntax

def get_speaker_manufacturer_id(speaker_index: int) -> int: ...

Default Value

0

Remarks

Manufacturer identifier for the device driver for the device.

The speaker_index parameter specifies the index of the item in the array. The size of the array is controlled by the speaker_count property.

This property is read-only.

speaker_name Property

Product name in a null-terminated string.

Syntax

def get_speaker_name(speaker_index: int) -> str: ...

Default Value

""

Remarks

Product name in a null-terminated string.

The speaker_index parameter specifies the index of the item in the array. The size of the array is controlled by the speaker_count property.

This property is read-only.

speaker_product_id Property

Product identifier for the device as assigned by Windows.

Syntax

def get_speaker_product_id(speaker_index: int) -> int: ...

Default Value

0

Remarks

Product identifier for the device as assigned by Windows.

The speaker_index parameter specifies the index of the item in the array. The size of the array is controlled by the speaker_count property.

This property is read-only.

speaker_support Property

Bitmask of optional functionalities supported by the device.

Syntax

def get_speaker_support(speaker_index: int) -> int: ...

Default Value

0

Remarks

Bitmask of optional functionalities supported by the device. This field can have one or more of the following values OR'd together:

The speaker_index parameter specifies the index of the item in the array. The size of the array is controlled by the speaker_count property.

This property is read-only.

speaker_supported_formats Property

Bitmask of standard formats that are supported.

Syntax

def get_speaker_supported_formats(speaker_index: int) -> int: ...

Default Value

0

Remarks

Bitmask of standard formats that are supported. This field can have one or more of the following values OR'd together:

The speaker_index parameter specifies the index of the item in the array. The size of the array is controlled by the speaker_count property.

This property is read-only.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

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

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_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:

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

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

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.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

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:

ssl_cert_subject Property

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

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

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.

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

user Property

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

Syntax

def get_user() -> str: ...
def set_user(value: str) -> None: ...

user = property(get_user, 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 class via activate.

activate Method

Activates the class.

Syntax

def activate() -> None: ...

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 on_activated event will fire.

answer Method

Answers an incoming phone call.

Syntax

def answer(call_id: str) -> None: ...

Remarks

This method can be used to answer an incoming phone call, specified by callId. This method can be used in conjunction with the on_incoming_call event, for example: ipphone.onIncomingCall += (sender, e) => { ipphone.Answer(e.CallId); }; If successful, on_call_ready will fire.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

deactivate Method

Deactivates the class.

Syntax

def deactivate() -> None: ...

Remarks

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

decline Method

Declines an incoming phone call.

Syntax

def decline(call_id: str) -> None: ...

Remarks

This method can be used to decline an incoming phone call, specified by callId. This method can be used in conjunction with the on_incoming_call event, for example: ipphone.onIncomingCall += (sender, e) => { ipphone.Decline(e.CallId); };

dial Method

Used to make a call.

Syntax

def dial(number: str, caller_number: str, wait: bool) -> str: ...

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 on_outgoing_call event will fire after calling this method. on_dial_completed may fire when the dial process is complete. If successful, on_call_ready 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 on_outgoing_call, on_call_ready, and on_call_state_changed, or found in the call's State field. Exceptions throughout the call process will be reported in on_dial_completed, 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 on_dial_completed event. Any references to the original CallId must be updated accordingly. Please see on_dial_completed 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"); }

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

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

forward Method

Used to forward an incoming call.

Syntax

def forward(call_id: str, number: str) -> None: ...

Remarks

This method can be used to implement call forwarding, allowing incoming calls, given by callId to be forwarded to a particular user specified by number. This method can be used in conjunction with the on_incoming_call event, for example: ipphone.onIncomingCall += (sender, e) => { ipphone.Forward(e.CallId, "123456789"); };

hangup Method

Used to hang up a specific call.

Syntax

def hangup(call_id: str) -> None: ...

Remarks

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

hangup_all Method

Used to hang up all calls.

Syntax

def hangup_all() -> None: ...

Remarks

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

hold Method

Places a call on hold.

Syntax

def hold(call_id: str) -> None: ...

Remarks

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

join_conference Method

Adds a call to a conference call.

Syntax

def join_conference(call_id: str, conference_id: str) -> None: ...

Remarks

This method is used to add a call, specified by callId, to a conference call.

The conferenceId parameter specifies the unique ID of the conference call. If no conference ID exists, the class will start a new conference call with this ID.

leave_conference Method

Removes a call from a conference call.

Syntax

def leave_conference(call_id: str) -> None: ...

Remarks

This method is used to remove a call, specified by callId, from a conference call. If the call is not a part of any conference call, an exception will be thrown.

list_conferences Method

Lists ongoing conference calls.

Syntax

def list_conferences() -> str: ...

Remarks

This method is used to list ongoing conferences any of the class's calls are currently a part of. Calling this will return a string with the following format:

ConferenceId_1: CallId_1, CallId_2

...

ConferenceId_n: CallId_3, CallId_4, CallId_5, ...

list_microphones Method

Lists all microphones detected on the system.

Syntax

def list_microphones() -> None: ...

Remarks

This method lists all microphones detected on the system. Calling this method will populate the Microphone* properties.

list_speakers Method

Lists all speakers detected on the system.

Syntax

def list_speakers() -> None: ...

Remarks

This method lists all speakers detected on the system. Calling this method will populate the Speaker* properties.

mute_microphone Method

Used to mute or unmute the microphone for a specified call.

Syntax

def mute_microphone(call_id: str, mute: bool) -> None: ...

Remarks

This method can be used to either mute or unmute the microphone for a specified call, given by callId. When mute is true, the microphone will be muted for the call. When false, the microphone will be unmuted.

mute_speaker Method

Used to mute or unmute the speaker for a specified call.

Syntax

def mute_speaker(call_id: str, mute: bool) -> None: ...

Remarks

This method can be used to either mute or unmute the speaker for a specified call, given by callId. When mute is true, the speaker will be muted for the call. When false, the speaker will be unmuted.

ping Method

Used to ping the server.

Syntax

def ping(timeout: int) -> None: ...

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.

play_bytes Method

This method is used to play bytes to a call.

Syntax

def play_bytes(call_id: str, bytes_to_play: bytes, last_block: bool) -> None: ...

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 on_played event will fire.

The lastBlock parameter indicates whether the class will expect further uses of play_bytes. When true, this indicates that no additional bytes will be provided for this particular audio stream, and on_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 play_bytes. Once all bytes have played and the buffer is empty, on_played will fire as expected, and will continue firing until the lastBlock parameter is set to true. Within on_played, the user can provide further bytes to play_bytes. Please see below for detailed examples on how to use this method with on_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 }

play_file Method

Plays audio from a WAV file to a call.

Syntax

def play_file(call_id: str, wav_file: str) -> None: ...

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 on_call_ready 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 on_played event will fire when the audio for the specified call has finished playing. Consecutive uses of play_text or play_file can prevent prior audio transmissions from being completed. In the below example, on_played will only fire for the second call to play_text:

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.

play_text Method

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

Syntax

def play_text(call_id: str, text: str) -> None: ...

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 on_call_ready has fired.

Note that this class can handle playing audio to concurrent calls. This method is non-blocking and will return immediately. The on_played event will fire when the audio for the specified call has finished playing. Consecutive uses of play_text and play_file can prevent prior audio transmissions from completing. In the below example, on_played will only fire for the second call to play_text:

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

Reset the class.

Syntax

def reset() -> None: ...

Remarks

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

set_microphone Method

Sets the microphone used by the class.

Syntax

def set_microphone(microphone: str) -> None: ...

Remarks

This method is used to set the Microphone that will be used by the class.

The microphone parameter specifies the name of the microphone to be set. To get the available microphones on the system, call list_microphones. Then, set the microphone with a name specified in the Microphone* properties.

Example ipphone.ListMicrophones(); ipphone.SetMicrophone(ipphone.Microphones[0].Name);

set_speaker Method

Sets the speaker used by the class.

Syntax

def set_speaker(speaker: str) -> None: ...

Remarks

This method is used to set the speaker that will be used by the class.

The speaker parameter specifies the name of the speaker to be set. To get the available speakers on the system, call list_speakers. Then, set the speaker with a name specified in the Speaker* properties.

Example ipphone.ListSpeakers(); ipphone.SetSpeaker(ipphone.Speakers[0].Name);

start_recording Method

Used to start recording the audio of a call.

Syntax

def start_recording(call_id: str, filename: str) -> None: ...

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

stop_playing Method

Stops audio from playing to a call.

Syntax

def stop_playing(call_id: str) -> None: ...

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 set_microphone, however, will stop audio transmitting from usage of play_text, play_file, and play_bytes.

Note that on_played will not fire when this method is used.

stop_recording Method

Stops recording the audio of a call.

Syntax

def stop_recording(call_id: str) -> None: ...

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.

transfer Method

Transfers a call.

Syntax

def transfer(call_id: str, number: str) -> None: ...

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.

type_digit Method

Used to type a digit.

Syntax

def type_digit(call_id: str, digit: str) -> None: ...

Remarks

This method can be used to type a digit, mimicking the functionality of a phone's keypad.

The callId parameter specifies the call that will receive the virtual keypad input.

The digit parameter specifies the digit that will be typed. Valid inputs include: 0-9, *, #

unhold Method

Takes a call off hold.

Syntax

def unhold(call_id: str) -> None: ...

Remarks

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

on_activated Event

This event is fired immediately after the class is activated.

Syntax

class IPPhoneActivatedEventParams(object):
# In class IPPhone:
@property
def on_activated() -> Callable[[IPPhoneActivatedEventParams], None]: ...
@on_activated.setter
def on_activated(event_hook: Callable[[IPPhoneActivatedEventParams], None]) -> None: ...

Remarks

The on_activated event will fire after the class has successfully registered with the SIP Server via activate.

on_call_ready Event

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

Syntax

class IPPhoneCallReadyEventParams(object):
  @property
  def call_id() -> str: ...

# In class IPPhone:
@property
def on_call_ready() -> Callable[[IPPhoneCallReadyEventParams], None]: ...
@on_call_ready.setter
def on_call_ready(event_hook: Callable[[IPPhoneCallReadyEventParams], None]) -> None: ...

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 on_outgoing_call and on_dial_completed, assuming dial was successful.

The CallId parameter is the unique Call-ID of the call.

on_call_state_changed Event

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

Syntax

class IPPhoneCallStateChangedEventParams(object):
  @property
  def call_id() -> str: ...

  @property
  def state() -> int: ...

# In class IPPhone:
@property
def on_call_state_changed() -> Callable[[IPPhoneCallStateChangedEventParams], None]: ...
@on_call_state_changed.setter
def on_call_state_changed(event_hook: Callable[[IPPhoneCallStateChangedEventParams], None]) -> None: ...

Remarks

The on_call_state_changed 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:

on_call_terminated Event

This event is fired after a call has been terminated.

Syntax

class IPPhoneCallTerminatedEventParams(object):
  @property
  def call_id() -> str: ...

# In class IPPhone:
@property
def on_call_terminated() -> Callable[[IPPhoneCallTerminatedEventParams], None]: ...
@on_call_terminated.setter
def on_call_terminated(event_hook: Callable[[IPPhoneCallTerminatedEventParams], None]) -> None: ...

Remarks

The on_call_terminated 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.

on_deactivated Event

This event is fired immediately after the class is deactivated.

Syntax

class IPPhoneDeactivatedEventParams(object):
# In class IPPhone:
@property
def on_deactivated() -> Callable[[IPPhoneDeactivatedEventParams], None]: ...
@on_deactivated.setter
def on_deactivated(event_hook: Callable[[IPPhoneDeactivatedEventParams], None]) -> None: ...

Remarks

The on_deactivated event will fire after the class has unregistered from the SIP Server via deactivate.

on_dial_completed Event

This event is fired after the dial process has finished.

Syntax

class IPPhoneDialCompletedEventParams(object):
  @property
  def original_call_id() -> str: ...

  @property
  def call_id() -> str: ...

  @property
  def caller() -> str: ...

  @property
  def callee() -> str: ...

  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class IPPhone:
@property
def on_dial_completed() -> Callable[[IPPhoneDialCompletedEventParams], None]: ...
@on_dial_completed.setter
def on_dial_completed(event_hook: Callable[[IPPhoneDialCompletedEventParams], None]) -> None: ...

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.

The Caller parameter specifies the user that initially made the call. The Callee parameter specifies the final recipient of the call.

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

on_digit Event

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

Syntax

class IPPhoneDigitEventParams(object):
  @property
  def call_id() -> str: ...

  @property
  def digit() -> str: ...

# In class IPPhone:
@property
def on_digit() -> Callable[[IPPhoneDigitEventParams], None]: ...
@on_digit.setter
def on_digit(event_hook: Callable[[IPPhoneDigitEventParams], None]) -> None: ...

Remarks

The on_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 type_digit. Detectable inputs include: 0-9, *, #

The CallId parameter is the unique Call-ID of the call.

on_error Event

Information about errors during data delivery.

Syntax

class IPPhoneErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class IPPhone:
@property
def on_error() -> Callable[[IPPhoneErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[IPPhoneErrorEventParams], None]) -> None: ...

Remarks

The on_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.

on_incoming_call Event

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

Syntax

class IPPhoneIncomingCallEventParams(object):
  @property
  def call_id() -> str: ...

  @property
  def remote_user() -> str: ...

# In class IPPhone:
@property
def on_incoming_call() -> Callable[[IPPhoneIncomingCallEventParams], None]: ...
@on_incoming_call.setter
def on_incoming_call(event_hook: Callable[[IPPhoneIncomingCallEventParams], None]) -> None: ...

Remarks

The on_incoming_call 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.

on_log Event

This event is fired once for each log message.

Syntax

class IPPhoneLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class IPPhone:
@property
def on_log() -> Callable[[IPPhoneLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[IPPhoneLogEventParams], None]) -> None: ...

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:

Note: When LogLevel is set to 3 (Debug), we strongly advise against performing long-running operations inside of this event due to large amounts of sent and received audio bytes. For example, continuously updating an interface displaying the Log data will cause major performance issues in an application. It is recommended to set LogLevel to 3 only when writing Log data to a stream or file. There will be no performance issues in this case.

Message is the log message.

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

• Info
• Packet
• RTP

on_outgoing_call Event

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

Syntax

class IPPhoneOutgoingCallEventParams(object):
  @property
  def call_id() -> str: ...

  @property
  def remote_user() -> str: ...

# In class IPPhone:
@property
def on_outgoing_call() -> Callable[[IPPhoneOutgoingCallEventParams], None]: ...
@on_outgoing_call.setter
def on_outgoing_call(event_hook: Callable[[IPPhoneOutgoingCallEventParams], None]) -> None: ...

Remarks

The on_outgoing_call 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.

on_played Event

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

Syntax

class IPPhonePlayedEventParams(object):
  @property
  def call_id() -> str: ...

  @property
  def completed() -> bool: ...

# In class IPPhone:
@property
def on_played() -> Callable[[IPPhonePlayedEventParams], None]: ...
@on_played.setter
def on_played(event_hook: Callable[[IPPhonePlayedEventParams], None]) -> None: ...

Remarks

The on_played event will fire after the class finishes playing available audio to a call. When using play_text or play_file, Completed will always be true. However, this will not always be the case when using play_bytes.

When playing audio via play_bytes, 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 play_bytes (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 play_bytes (i.e., lastBlock is true). Please see the method description for more details.

The CallId parameter is the unique Call-ID of the call.

on_record Event

This event is fired when recorded audio data is available.

Syntax

class IPPhoneRecordEventParams(object):
  @property
  def call_id() -> str: ...

  @property
  def recorded_data() -> bytes: ...

# In class IPPhone:
@property
def on_record() -> Callable[[IPPhoneRecordEventParams], None]: ...
@on_record.setter
def on_record(event_hook: Callable[[IPPhoneRecordEventParams], None]) -> None: ...

Remarks

This event is fired when a call's recorded data is available. This data is made available when either stop_recording is called or the call is terminated. Note that for this event to fire, start_recording 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.

on_silence Event

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

Syntax

class IPPhoneSilenceEventParams(object):
  @property
  def call_id() -> str: ...

# In class IPPhone:
@property
def on_silence() -> Callable[[IPPhoneSilenceEventParams], None]: ...
@on_silence.setter
def on_silence(event_hook: Callable[[IPPhoneSilenceEventParams], None]) -> None: ...

Remarks

The on_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 Call-ID of the call.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class IPPhoneSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class IPPhone:
@property
def on_ssl_server_authentication() -> Callable[[IPPhoneSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[IPPhoneSSLServerAuthenticationEventParams], None]) -> None: ...

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.

on_ssl_status Event

Shows the progress of the secure connection.

Syntax

class IPPhoneSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class IPPhone:
@property
def on_ssl_status() -> Callable[[IPPhoneSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[IPPhoneSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

IPPhone Config Settings

The class 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 class, access to these internal properties is provided through the config method.

IPPhone Config Settings

Base Config Settings

IPPhone Errors

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 local_port while the class is active.
	107   You cannot change the local_host at this time. A connection is in progress.
	109   The class must be active for this operation.
	112   Cannot change MaxPacketSize while the class is active.
	113   Cannot change ShareLocalPort option while the class is active.
	114   Cannot change remote_host when UseConnection is set and the class active.
	115   Cannot change remote_port when UseConnection is set and the class is active.
	116   remote_port can't be zero when UseConnection is set. Please specify a valid service port number.
	117   Cannot change UseConnection while the class 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).