Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

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

digium.event.observe

Description

Set a callback function to be fired when the request eventName fires. 

Basic Example: 

digium.event.observe(parameters);

Parameters

Name

Required

Type

Default

Description

eventName

Yes

string

String that identifies the event type. Event type can either be from this list if you are using digium.event.observe, or from your own list if you're using digium.event.fire to fire your own event. 

callback

No

object

Called when an event arrives and contains an Object with the following:

  • callHandle - the string identifying the call. This is only present when the notification is attached to an incoming call.

  • method - the SIP method type used to deliver the message. INFO, INVITE, or MESSAGE.

  • eventName - the string identifying the pushed event type

  • eventData - data associated with the message (from the x-event-data header or the body of an INFO or MESSAGE). If data can be parsed as JSON, the parsed object is used; otherwise, this field contains a string.

  • messageId - ID string for the event.

A full list of system eventNames can be found here.

  • No labels

Return to Documentation Home I Return to Sangoma Support