Versions Compared

Key

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

...

Note: The API will only accept POST requests.

Before you can stop a recording you must first obtain a timestamp and a security token via the Authentication method.

There are two forms of the stop method; one which takes the extension number to start recording on and the other takes the uniquecallid generated by asterisk.

By ExtensionRecording API

The stop method takes a single argumenttwo arguments: extension, agentLoginName

The extension is the telephone extension and is resolved by stripping the tech and unique identifier from channel names. ie SIP/410-12FA7B becomes 410.

The agentLoginName is the NoojeeContact username which is used to determine if the user has permission to stop a recording. 

Code Block
linenumberstrue
httphttps://<server host>/servicemanager/rest/CallManagementAPI/stop?extenOrUniqueId=410&
agentLoginName=Fred&timeStamp=1264853382&hash=45678905678956789678906789apiKey=f863246a-973e-11e6-8784-08002718f5b5

This method returns the standard HTTP status '200' on success otherwise an error message is returned.

By uniquecallidRecording API

The stop method takes a single argument: uniquecallidtwo arguments: extension, agentLoginName

The uniquecallid extension is the unique identifier that Asterisk assigns to each active call.telephone extension and is resolved by stripping the tech and unique identifier from channel names. ie SIP/410-12FA7B becomes 410.

The agentLoginName is the NoojeeContact username which is used to determine if the user has permission to stop a recording. 

Code Block
linenumberstrue
httphttps://<server host>/servicemanager/rest/CallManagementAPI/stop?extenOrUniqueId=12347811.214&
agentLoginName=Fred&timeStamp=1264853382&hash=45678905678956789678906789

 

apiKey=f863246a-973e-11e6-8784-08002718f5b5


This method returns the standard HTTP status '200' on success otherwise an error message is returned. 


Code Block
linenumberstrue
https://<server host>/rest/CallManagementAPI/stop?extenOrUniqueId=410&
agentLoginName=Fred&timeStamp=1264853382&hash=45678905678956789678906789
apiKey=f863246a-973e-11e6-8784-08002718f5b5