JSON API » recording » recording/groups/create

Creates a new record group.

Input parameters

Requires authentication and the administrator role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
name	String	Name.	Yes
customer	Integer	ID of customer to create in.	No	Customer of authentication user.
description	String	Description.	No	Empty string.
email	String	Email address(es) to send recordings to.	No	Empty string.
expires	Integer	Expiry time in days. 0 not to save.	No	365
fraction	Integer	Percentage of recordings to save. 0 for on demand only.	No	100
beep	Integer	Interval in seconds to play beep while recording. 0 for no beep.	No	0
message	Integer	Whether to play message that call is being recorded. "all", "inbound", "inbound_outbound", "internal", "outbound", or empty string for none.	No	Empty string.
owner	Integer	ID of owner. 0 for none.	No	0
record_in	Integer	1 to record inbound calls, 0 not to.	No	1
record_out	Integer	1 to record outbound calls, 0 not to.	No	1
validation	Integer	1 to validate input then return, 0 for full action.	No	0
transcribe	Integer	1 to transcribe recording, 0 no to.	No	0

Responses

Code	Description
200	Success.
201	Input passed validation. Only returned if validation=1.
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.

Data returned

The ID of the created record group.

Example: With required parameters

http://enswitch.example.com/api/json/recording/groups/create/?auth_username=user;auth_password=password;name=example

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }

Change history

Version	Changes
4.2	transcribe parameter added.
4.0	message parameter added.
3.15	beep input parameter added.
3.14	fraction input parameter changed to allow a value of 0.
3.13	Function added.