04.0 Hangup
Terminate a call or hang up. This method is typically used after having initiated a call using the dial method.
Entry point:
https://<server host>/servicemanager/rest/CallManagementAPI/hangup
HTTP Method: POST
Content Type: application/x-www-form-urlencoded
Parameters:
Argument | Description | Mandatory |
|---|---|---|
extenOrUniqueId | The handset extension no. or the uniqueCallId of a channel. Its recommended that you use the uniqueCallId (obtained via the subscribe api call) rather than the extension no. Hanging up a call via an extension no. can result in the wrong call being hungup if there is more than one call on the handset. | yes |
apiKey | api key provided by Noojee Support | yes |
Sample Hangup query:
By unique id: (recommended)
https://<server host>/servicemanager/rest/CallManagementAPI/hangup?
apiKey=f863246a-973e-11e6-8784-08002718f5b5&
extenOrUniqueId=342082345-238.234
By extension no. (not recommended)
https://<server host>/servicemanager/rest/CallManagementAPI/hangup?
apiKey=f863246a-973e-11e6-8784-08002718f5b5&
extenOrUniqueId=100
Sample success response:
{"Message":"Channel Hungup","Code":0}