Phone API Reference - Core - digium.event - List of Event Types

Desk Phone API features described in this section are deprecated and supported only on the following models: D40, d45, d50, d60, d62, d65, d70

App Events

digium.app.background

Called when an application is about to be put in the background.

digium.app.exit

Called when an application is about to shut down.

digium.app.foreground

Called when the application is put into the foreground. The application name and any arguments from appconfig will be passed as arguments to the callback.

digium.app.idle_screen_hide

Called with no arguments when the app idlescreen window is hidden in the GUI.

digium.app.idle_screen_show

Called with no arguments when the app idlescreen window is displayed by the phone GUI.

digium.app.start

Called when the app first starts up.

 Phone Events

digium.phone.contact_presence

Called whenever a subscribed user updates his/her presence information.

digium.phone.contact_update

Called when new contact information is received from the server. The app then rebuilds any data structures based on the result of digium.contacts.getList().

digium.phone.icon_change

Called whenever an application changes its icon. Callback will be passed the name of the application in the eventData parameter.

digium.phone.app_install

Called when an application is installed or reinstalled. Callback will be passed the name of the application in the eventData parameter.

digium.phone.incoming_call

Called to notify of an incoming phone call.  The eventData properties are the same as those given to a handler in the digium.phone api.

digium.phone.mwi

Called when a Message Waiting Indicator arrives. For example, a voicemail notification.

digium.phone.new_config

Called when the phone's configuration file has changed.

digium.phone.outgoing_call

Called to notify of an outgoing phone call.  The eventData properties are the same as those given to a handler in the digium.phone api.

digium.phone.play_status

Called about every second while an audio file is playing, to give status. Also called when playback stops.

digium.phone.server_change

Called to provide failover status for accounts. 

 

Return to Documentation Home I Return to Sangoma Support