API : SIP Account Move numbers

This request moves phone numbers from one SIP account to another SIP account of the same customer - between two standalone SIP trunks, between two hosted PBX trunks, or between a PBX trunk and a standalone trunk.

A move keeps the numbers exactly as they are and only changes which SIP account holds them: the state, live date, listing in phone books, the user (employee) or name, the number's own address (addressOverride) and an ongoing porting all stay. Removing a number from one account with Update and adding it to another would instead release the number in between, delete its voicemail messages, and is refused when the hosted PBX uses the number.

• A number series always moves as a whole. Asking for one number of a series moves the whole series - the reply lists all numbers moved.
• Every number must be on the SIP account in the URL. A number being ported out cannot move. A number being ported in can only move together with the other numbers of the same porting; the porting then delivers the numbers to the new SIP account.
• Voicemail messages of the numbers follow them (each number has its own mailbox). If the new SIP account has no voicemail of its own (a hosted PBX trunk never has), the messages are kept but the numbers do not go to voicemail.
• If the default number of a standalone SIP account is moved, the account's first remaining number becomes the default number. A standalone account without a default number gets its first number as default number - its own numbers come first, the moved numbers after them.
• The routing of the numbers (SBC) is changed at once - calls to the numbers go to the new SIP account as soon as the request returns.
• Both SIP accounts get a change log entry (Numbers moved to … and Numbers moved from …) and a SIP_ACCOUNT_UPDATED realtime event, and every number a NUMBER_UPDATED event.

The hosted PBX routes inbound calls by number, never by SIP account, so what happens depends on the two accounts (kind in the reply):

When the numbers leave the PBX, these references are changed automatically - use dryRun first to see them (a dry run also requires write access to the PBX when there are references):

Each changed dialplan item is logged in the change log and announced on the realtime channel (PBX_<TYPE>_UPDATED) like any other update of it. When an extension loses its direct number, the search data of its user and SIP phones is updated too. Changing the PBX requires write access to the customer's PBX as well.

{
  to: '1234567890ABCDEF12345679',
  numbers: ['+4570305010', '+4570305011'],
  dryRun: true
}

The same for a dry run and a real move - a real move adds done.

{
  dryRun: true,
  from: '1234567890ABCDEF12345678',
  to: '1234567890ABCDEF12345679',
  numbers: ['+4570305010', '+4570305011'],
  kind: 'LEAVES_PBX',
  dependencies: [
    { type: 'TRUNK', id: '1234567890ABCDEF1234567A', name: 'Hovednummer', itemNumber: null, field: 'numbers', number: '+4570305010', action: 'REMOVE' },
    { type: 'EXTENSION', id: '1234567890ABCDEF1234567B', name: 'Per', itemNumber: '201', field: 'direct', number: '+4570305010', action: 'CLEAR' },
    { type: 'EXTENSION', id: '1234567890ABCDEF1234567B', name: 'Per', itemNumber: '201', field: 'outbound.callerId.onPresenceWork', number: '+4570305010', action: 'RESET', resetTo: '+4570305000' }
  ],
  warnings: [
    { code: 'ADDRESS_DIFFERS', numbers: ['+4570305010'] }
  ]
}

A number that cannot move gives one error per number with the code numbers[E.164Number]. Several such errors are returned together as a 422 multiple error, with the single errors in inner. Invalid input in the request body gives only the first error found.