API : PBX : SIP phone Update

This request will update a SIP phone.

A SIP phone handles all aspects of connecting and configuring the phone.

When a Snom or Aastra SIP phone is connected, it will configured for MAC redirection. This means that when a phone boots for the first time or after a reset it will ask the vendor for a configuration server, which will be this system. It will then fetch the configuration and auto-configure itself.

Others supported phones such as some Linksys and Cisco models can also configure themself, but need to be pointed to the provisioning server at: https://prov.telecomx.dk, or have the DHCP server on their network use OPTION 66 to point to the provisioning server.

A configured phone is not enough to make or receive calls, for that the SIP phone need to linked to an extension.

When updating as little as a single property can be updated.

Properties that are not supported by the phone model or not needed, does not need to be specified. If network.dhcp is true, then ipAdress, subnet, gateway, dns1 and dns2 can be omitted. Likewise if default vlan settings should be used, they can be omitted as well.

{
  macAddress: '4EE8A34B56F3',
  callWaiting: false,
  ip: {
    mode: 'OPEN'
  }
}

The response will be the updated SIP phone, if no errors occurred.

Note that properties holding no value may be omitted from the object.

{
  _id: '12345678901234567890ABCD',
  pbxCluster: 1,
  sipPhoneModel: '1234567890123457890AAAA',
  extension: '123457890123457890BBBB',
  customer: '1234567890123456780CCCC',
  macAddress: '4EE8A34B56F3',
  handsetAddress: null,
  handsetIndex: null,
  callWaiting: false,
  notes: 'A note about the phone',
  softkeyConfigurationOnDevice: true,
  softkeyBlfBlindTransfer: false,
  ip: {
    mode: 'OPEN',
    countries: '',
    address: ''
  },
  username: '2yu9hjfy23iuhdwg9ewhufghuiweghui',
  password: 'g9ewhufg2yu9hjfy2whuiweghui3iuhd',
  instanceId: null,
  ringer: {
    volume: 4,
    tone: 2
  },
  volume: {
    handset: { mic: 5, speaker: 7 },
    headset: { mic: 5, speaker: 7 },
    handsfree: { mic: 3, speaker: 4 }
  },
  softkeys: [
    { index: 0, function: 'SPEEDDIAL', value: '112', label: 'Emergency' },
    { index: 1, function: 'BLF', value: '1234567890123457890FFFF', label: 'Hans Christian Anderson' }
  ],
  codec: { hdAudio: true, video: false },
  network: {
    dhcp: false,
    ipAddress: '192.168.1.10',
    subnet: '255.255.255.0',
    gateway: '192.168.1.1',
    dns1: '192.168.1.1',
    dns2: '8.8.8.8',
    vlanId: 0,
    vlanPriority: 5
  },
  status: {
    configLoaded: '2015-01-01T00:00:00Z',
    configSaved: '2015-01-01T00:00:00Z',
    online: true,
    expires: 2543,
    localIpAddress: '192.168.1.10',
    publicIpAddress: '213.83.176.134',
    userAgent: 'snom370/8.7.3.25'
  },
  purchaseInfo: {
    orderId: '729291',
    date: '2020-01-30T00:00:00Z',
    paymentOption: 'BOUGHT',
    sidePanels: [
     {
        serial: '1234',
        paymentOption: "RENTED",
        date: '2015-01-01-T00:00:00Z',
        orderId: '1234678',
        product: '1234567890ABCDEF12345678'
     }, 
     {
        serial: '2341',
        paymentOption: "RENTED",
        date: '2015-01-01-T00:00:00Z',
        orderId: '98850',
        product: '1234567890ABCDEF12345678'
     }
    ]
  }
}