JSON API » recording » recording/groups/update

Updates an existing record group.

Input parameters

Requires authentication and the record role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of record group to update.Yes
descriptionStringDescription.NoCurrent value.
emailStringEmail address(es) to send recordings to.NoCurrent value.
expiresIntegerExpiry time in days. 0 not to save.NoCurrent value.
fractionIntegerPercentage of recordings to save. 0 for on demand only.NoCurrent value.
beepIntegerInterval in seconds to play beep while recording. 0 for no beep.No0
nameStringName.NoCurrent value.
ownerIntegerID of owner. 0 for none.NoCurrent value.
record_inInteger1 to record inbound calls, 0 not to.NoCurrent value.
record_outInteger1 to record outbound calls, 0 not to.NoCurrent value.
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
201Input passed validation. Only returned if validation=1.
204Success.
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.
404The record group does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Changing the name

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

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

Change history

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