Phone API Reference - Core - digium.phone.hangup

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.phone.hangup

 

Description

Hangs up on an ongoing call.

 

Basic Example: 

digium.phone.hangup(parameters);

If a function is passed in the handler parameter, that function is called with a call status object to notify of state changes to the phone call.

 

Parameters

Name

Required

Type

Default

Description

Name

Required

Type

Default

Description

callHandle

Yes

string

 

Identifier of the call to act on. A call handle can be obtained by observing call events. Information such as this will be passed into the event object.

handler

No

function

 

Handler to register for the call. Executed whenever the call changes state.

 

Examples

digium.phone.hangup with until.debug to print call state

digium.phone.hangup({     'callHandle' : callHandleVar,     'handler' : function (obj) {         util.debug(obj.callHandle);     } });

 

Return to Documentation Home I Return to Sangoma Support