JSON API » recording » recording/recordings/start

Starts/unpauses a call recording. The request is asynchronous, and may take a second or two after the function returns.

The recording will take place according to the telephone on the call, and its configured call recording group.

Input parameters

Requires authentication and the actions or panel role privilege. User must also be an administrator, owner of a telephone line involved, or allowed to use any telephone line.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
uniqueid	String	Uniqueid of call.	Yes
channel	Integer	1 to use the calling channel (calling telephone), 2 to use the called channel (called telephone).	No	1

Responses

Code	Description
204	Recording start/unpause successfully requested.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
403	Your rate plan does not allow this.
404	The call does not exist, or you do not have permission to view it.

Data returned

No data is returned.

Example: With required and optional parameters

http://enswitch.example.com/api/json/recording/recordings/start/?auth_username=user;auth_password=password;uniqueid=1234567890.123456;channel=2

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
4.1	Function added.