JSON API » recording » recording/groups/update

Updates an existing record group.

Input parameters

Requires authentication and the record role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of record group to update.	Yes
description	String	Description.	No	Current value.
email	String	Email address(es) to send recordings to.	No	Current value.
expires	Integer	Expiry time in days. 0 not to save.	No	Current value.
fraction	Integer	Percentage of recordings to save. 0 for on demand only.	No	Current value.
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	Current value.
name	String	Name.	No	Current value.
owner	Integer	ID of owner. 0 for none.	No	Current value.
record_in	Integer	1 to record inbound calls, 0 not to.	No	Current value.
record_out	Integer	1 to record outbound calls, 0 not to.	No	Current value.
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
201	Input passed validation. Only returned if validation=1.
204	Success.
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 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

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.