Versions Compared

Old Version 2

changes.mady.by.user Ross Kennewell

Saved on

compared with

New Version Current

changes.mady.by.user Brett Sutton

Saved on

Key

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

...

Code Block
linenumberstrue
httphttps://<server host>/servicemanager/rest/CallManagementAPI/hangup

HTTP Method: POST

Content Type: application/x-www-form-urlencoded

Parameters:

...

Argument

...

Description

...

extenOrUniqueId - the internal or agent extension.
apiKey - api key provided by Noojee Support
– OR --
timeStamp - the authentication timestamp.
hash - the authentication signature or hash.

...

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
apiKeyapi key provided by Noojee Supportyes


Sample Hangup query:

By unique id: (recommended)

Code Block
linenumberstrue
httphttps://<server host>/servicemanager/rest/CallManagementAPI/hangup?
apiKey=f863246a-973e-11e6-8784-08002718f5b5&
extenOrUniqueId=100

...

342082345-238.234


By extension no. (not recommended)

Code Block
linenumberstrue
httphttps://<server host>/servicemanager/rest/CallManagementAPI/hangup?
timeStamp=1412212472393&
hash=b529f3e9d6d20e40ff232a07c02bcad62fe6da45755abfeb618af09c9f781bf7apiKey=f863246a-973e-11e6-8784-08002718f5b5&
extenOrUniqueId=100



Sample success response:

Code Block
linenumberstrue
{"Message":"Channel Hungup","Code":0}

Sample expired timestamp response. When the timestamp expires, the call must be repeated with a newly acquired timestamp.

Code Block
linenumberstrue
{"Message":"Expired TimeStamp","Code":-1}