2.0 Start Recording

Owned by PeterF (Deactivated)
Sept 06, 2016
1 min read

Deprecated: The recording API has been replaced by the new Noojee API.

The recording API will no longer be supported post the release of 4.0

Starting a Recording

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.

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

By Extension

This start method takes 2 arguments: extension and tag.

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

The tag is written to the call record in the database and appears as the "External Reference" field on a call record.

URL: http://{somehost}/servicemanager/rest/RecordingAPI/start?extenOrUniqueId=410&tag=22&agentLoginName=Fred&timeStamp=1264853382&hash=45678905678956789678906789

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.

The uniquecallid is the unique identifier that Asterisk assigns to each active call.

The tag is written to the call record in the database and appears as the "External Reference" field on a call record.

http://{somehost}/servicemanager/rest/RecordingAPI/start?extenOrUniqueId=410&tag=22&agentLoginName=Fred&timeStamp=1264853382&hash=45678905678956789678906789

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

Example

https://127.0.0.1/rest/RecordingAPI/start?extenOrUniqueId=410&tag=1234&agentLoginName=Fred&timeStamp=1264853382&hash=45678905678956789678906789