switchvox.scheduledReports.remove
From SwitchvoxExtendAPI
Contents |
Description
Remove a scheduled report from your system.
Arguments
- See the Constructing Requests page to learn how to use arguments in requests.
| Name | Required | Type | Default | Description |
| schedule_report_id | required | integer | ID of the scheduled report you want to remove. |
Example Requests & Responses
- Please see the API Request and Response Format section for more information on various request encodings.
Example One
Request
<request method="switchvox.scheduler.remove"> <parameters> <schedule_id>23</schedule_id> </parameters> </request>
Response
<response method="switchvox.scheduledReports.callReports.remove"> <result> <success /> </result> </response>
See switchvox.scheduledReports.add for more example requests and responses.
Error Codes
- See the Error Code Formatting section to see the xml structure when an error is returned.
- See the Generic Error Codes section to see a list of general fault codes that may be returned.
| Code | Description |
| 57139 | Requested scheduled report id does not exist in the system. |