Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

digium.event.observe

Description

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

 

Basic Example: 
Code Block
languagejs
digium.event.observe(parameters);

 

Parameters

 

NameRequiredTypeDefaultDescription
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.
Tip

A full list of system eventNames can be found here.