JSON API » recording » recording/groups/create

Creates a new record group.

Input parameters

Requires authentication and the administrator role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
nameStringName.Yes
customerIntegerID of customer to create in.NoCustomer of authentication user.
descriptionStringDescription.NoEmpty string.
emailStringEmail address(es) to send recordings to.NoEmpty string.
expiresIntegerExpiry time in days. 0 not to save.No365
fractionIntegerPercentage of recordings to save. 0 for on demand only.No100
beepIntegerInterval in seconds to play beep while recording. 0 for no beep.No0
ownerIntegerID of owner. 0 for none.No0
record_inInteger1 to record inbound calls, 0 not to.No1
record_outInteger1 to record outbound calls, 0 not to.No1
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
200Success.
201Input passed validation. Only returned if validation=1.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
403Your 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

VersionChanges
3.15beep input parameter added.
3.14fraction input parameter changed to allow a value of 0.
3.13Function added.