...
The recording api allows you to start a recording for a given extension or based on a unique call id. When starting a recording you can also stipulate a 'tag' that should be attached to the recording and which can later be used to retrieve the details of the recording.
START
Before you can start a recording you must first obtain a timestamp and a security token via the 1.0 Authentication method.
Note: The API will only accept POST requests.
...
By Extension
This start method takes 2 3 arguments: extension and tag.The .
| Argument | Description | Mandatory |
|---|---|---|
| extenOrUniqueId | This can either be an extension no. or a unique call id. When using an extension, the extension is the telephone extension that is to be recorded |
...
. e.g 100 When using a uniquecallid you would normally use a uniquecallid obtained via the Subscribe API call. e.g 23408102981.234 | Yes | |
| agentLoginName | A valid Noojee Contact Username. If passed it is used to set the owner of the recording leg. If the agentLoginName is not passed then the extension is used to find the that is currently attached to the extension. If a user is attached then that user is assigned the default ownership which means that only users that belong to the 'Recording Manager' group will have access to the leg. | No |
| Tag | The tag is written to the call record in the database and appears as the "External Reference" field on a call record. | No |
| apiKey | The api key for you asterisk system. The api key is stored as a System Variable. | Yes |
Example
| Code Block | ||
|---|---|---|
| ||
URL: httphttps://<server host>/servicemanager/rest/CallManagementAPI/start?extenOrUniqueId=410&tag=22 &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 uniquecallid
This start method takes 2 arguments: uniquecallid and tag.
...
uniquecallid
...
| Code Block | ||
|---|---|---|
| ||
httphttps://<server host>/servicemanager/rest/CallManagementAPI/start?extenOrUniqueId=4103412341214.123&tag=22 &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.
Example
...
| linenumbers | true |
|---|
...