These docs are for v2.11. Click to read the latest docs for v2.12.

Update Device

Update a Device.

Notes

id

12 digit valid device id

fonenumber

Caller id for the device, used when device makes the outbound call. It should be a valid FoneNumber

name

Name/Label for the device

type

Device type can ba FracTELfone, Trunk Device or a physical device like a Yealink phone or a Grandstream phone.

mac_address

Mac address of a physical phone. It is not required for FracTELfone or Trunk Device.
Ex: 1a:2b:3c:4d:5e or 1a2b3c4d5e

speed_dial

Set speed dial within your account using this parameter. FracTEL will assign a speed dial number if it is not set.

call_recording

Call recording can be set individually on a device. Default setting is set as account default. Options are:
default - Follow the account setting
yes - Record all calls
no- Don't record any calls
inbound - Only record inbound calls
outbound - Only record outbound calls
ondemand- Record call on demand

e911location_id

Set e911 location for the device. First create e911location and set that here.

areacode

Default arecode for outbound calls

timezone

Timezone to be used on physical phones

ring_simultaneously

Ring simultaneously if a device is registered at multiple locations

host_type

Host type of a Trunk device. It can be static or dynamic

host_ip

Host IP of a Trunk device. Host IP is the IP of the Trunk

host_port

Host Port of a Trunk device. Host Port is the port of the Trunk

timeout_service

Timeout service for the device. This service will be executed if ring to the device times out.

  • timeout_type - Timeout type can be None, Forward, Voicemail or Voice2Email.
  • timeout_id - Value of the timeout service.
  • timeout_seconds - Number of seconds after the call will timeout.
  • voice2email_greeting - Greeting message for Voice2Email timeout type.

busy_service

Busy service for the device. This service will be executed if the device is busy.

  • busy_type - Busy type can be None or Forward.
  • busy_id - Value of the busy service.

directory_settings

Directory setting for the device.

  • first_name - First Name to be displayed on Directory.
  • last_name - Last Name to be displayed on Directory.
  • show - Flag to show or hide from the directory.
  • speed_dial - Directory speed dial if different from regular speed dial.

forwardall_settings

Forward All calls setting for the device.

  • phonenumber - Phonenumber to forward all calls to.
  • start_time - Start time in HH:mm format.
  • end_time - End time in HH:mm format.

Sample Response

{
  "device": {
    "id": "535923697376",
    "name": "Sales x103",
    "fonenumber": "3215551111",
    "mac_address": "aabbccddee",
    "type": "Grandstream GXV3240",
    "speed_dial": "101",
    "call_recording": "default",
    "e911location_id": "",
    "areacode": "321",
    "qr_code": null,
    "ring_simultaneously": "3214991000",
    "receive_notify": {
      "type": "Callback",
      "email": "[email protected]",
      "url": "https://hookb.in/jeZdKeYKbbfobX0plXgJ",
      "method": "POST"
    },
    "send_notify": {
      "type": "None",
      "email": "[email protected]",
      "url": "https://hookb.in/jeZdKeYKbbfobX0plXgJ",
      "method": "GET"
    },
    "timeout_service": {
      "timeout_type": "Voicemail",
      "timeout_id": "VM2521095931",
      "timeout_seconds": 25,
      "voice2email_greeting": "Default"
    },
    "busy_service": {
      "busy_type": "Forward",
      "busy_id": "3214991000"
    },
    "directory_settings": {
      "first_name": "John",
      "last_name": "Doe",
      "show": true,
      "speed_dial": ""
    },
    "forwardall_settings": {
      "phonenumber": "3214991000",
      "start_time": "15:00",
      "end_time": "19:00"
    }
  }
}

Response Properties

PropertyTypeDescription
deviceobjectDevice
Language
Credentials
Header
Click Try It! to start a request and see the response here!