JSON API » recording » recording/recordings/update

Updates an existing call recording.

Input parameters

Requires authentication and the record role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
recordgroupIntegerID of record group to update from.Yes
uniqueidStringUnique ID of call recording to update.Yes
recordidStringRecord ID of call recording to update.Yes
expiresIntegerUnix timestamp when recording expires.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.
404The call recording does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Changing the expiry time

http://enswitch.example.com/api/json/recording/recordings/update/?auth_username=user;auth_password=password;recordgroup=123;uniqueid=1234567890;recordid=1;expires=1234567890

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

Change history

VersionChanges
3.13Function added.