API : PBX : Backup download

Introduction

Builds a PBX backup of the selected categories and returns it as a ZIP file download. The backup is not stored on the server - use Store for that.

Building the backup downloads all audio binaries from the audio file server, so the request may take a while for customers with many audio files.

Request

URL	https://api.telecomx.dk/pbx/backup/file
Method	GET
Access level	OWNER if the customer is the users own customer. RESELLER if the customer belongs to the reseller. RESELLER_ADMIN and ADMIN for all customers.
Query	customer	`[optional]` Id of customer to back up. Defaults to the users own customer.
Query	include	Comma separated list of categories to include: dialplan, audio, sipPhones, users. At least one is required.

Backing up the dialplan without the audio category produces a working backup, but all audio references will be cleared when it is restored (unless the audio still exists on the target customer).

Query examples

https://api.telecomx.dk/pbx/backup/file?include=dialplan,audio,sipPhones,users
https://api.telecomx.dk/pbx/backup/file?customer=12345678901234567890ABCD&include=dialplan,audio

Response

The response is the backup ZIP file (Content-Type application/zip) with a Content-Disposition filename like pbx-backup-<customer-name>-<yyyy-mm-dd>.zip.

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
404	customer	Customer not found
422	include	Invalid or missing categories
500	internal_error	<Unspecified>

WIKI

Table of Contents