Create Device

Add a new Device to an account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Notes

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 is required for 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 is required for Trunk devices. It can be static or dynamic

host_ip

Host IP is required for Trunk devices. Host IP is the IP of the Trunk

host_port

Host Port is required for Trunk devices. 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.
Response Properties
PropertyTypeDescription
deviceobjectDevice
Body Params
string

10-digit Caller ID for device. Leave it blank if device type is Trunk Device. Otherwise REQUIRED

string

Name/Label for device

string
required

Device type

string

Macaddress of device. Leave it blank if device type is FracTELfone OR WebRTC Device. Otherwise REQUIRED

string

1 to 6 digit speed dial for device. Leave it blank if device type is Trunk Device. Otherwise REQUIRED

string
enum

Call recording setting for device

Allowed:
string

ID of E911Location object

string

3-digit local area code for device

string

Timezone for device. Default timezone is EST5EDT

string

10-digit Phone number to ring simultaneously with device

string
enum

Host type for Trunk Device. REQUIRED if Device type is Trunk Device

Allowed:
string

Host IP for Trunk Device. REQUIRED if Host type is static

number

Host Port for Trunk Device. REQUIRED if Host type is static

timeout_service
object

Timeout Service for a Device.

busy_service
object

Busy Service for a Device.

directory_settings
object

Directory Settings for a Device.

forwardall_settings
object

ForwardAll Settings for a Device.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json