API : PBX : Backup restore

Restores a PBX backup from an uploaded backup ZIP file onto a target customer. To restore a backup stored on the file server, use Restore stored instead.

All restored items get new ids - every reference between the restored items (gotos, audio references, music on hold, users, phones, softkeys) is rewritten accordingly.

Two restore modes exist:

Behavior worth knowing:

• Phone numbers (trunk numbers, direct numbers) are only restored if the target customer owns them - other numbers are dropped and reported.
• Users are matched on the target customer by email address, or - for users without an email address - by name, title, department and access level (the first match is used when several fit). Matched users keep their current identity and credentials and only receive the backed up PBX settings. Users that do not exist are recreated with their backed up access level, email address and login credentials when possible; when that fails (e.g. the email address is in use on another customer) they are created as NO_LOGIN without an email address and must be invited afterwards.
• SIP phones keep their MAC address if it is free; a MAC in use by another phone is cleared and reported. SIP credentials are always regenerated.
• Communicator dashboards on the target customer are automatically repointed at the restored queues, extensions and groups.
• A restore takes a per-customer lock - only one restore can run per customer at a time.
• Use dryRun to validate the restore and get the full report with all warnings, without changing anything.

The restore report:

{
  mode: 'deploy',
  dryRun: false,
  categories: [ 'dialplan', 'audio', 'users' ],
  created: { dialplan: 42, audio: 17, users: 3 },
  updated: { users: 8 },
  warnings: [
    {
      type: 'NUMBER_DROPPED',
      item: '+4512345678',
      message: 'The phone number is not owned by the target customer and was dropped - attach a number manually'
    }
  ]
}