JSON API » recording » recording/recordings/update
Updates an existing call recording.
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 | |
recordgroup | Integer | ID of record group to update from. | Yes | |
uniqueid | String | Unique ID of call recording to update. | Yes | |
recordid | String | Record ID of call recording to update. | Yes | |
expires | Integer | Unix timestamp when recording expires. | No | Current value. |
validation | Integer | 1 to validate input then return, 0 for full action. | 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. |
404 | The 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
Version | Changes |
---|---|
3.13 | Function added. |