Device

FoneStorm device object representing a 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": "JSON"
  },
    "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
idstringUnique identifier of device.
namestringName/Label for device.
fonenumberstring10-digit outbound caller id for device.
mac_addressstringMac address of device.
typestringType for device. Please check Supported Devices for the list.
speed_dialstring1 to 6 digit Extension/SpeedDial for device.
call_recordingstringCall recording flag for device. default, yes, no, inbound, outbound or ondemand
e911location_idstringUnique identifier of e911location service.
areacodestring3-digit local are code.
qr_codestringQR code if device is a SoftPhone or a WebRTC device. Otherwise NULL.
ring_simultaneouslystring10-digit phone number.
receive_notifyobjectDevice's call received notification setting.
send_notifyobjectDevice's call initiated notification setting.
host_typestringHost type can be static or dynamic. Only Trunk Device requires this parameter
host_ipstringHost IP is used if host_type is static. Only Trunk Device requires this parameter
host_portstringHost Port is used if host_type is static. Only Trunk Device requires this parameter

receive_notify Object

PropertyTypeDescription
typestringType of the notification. Type can be None, Callback or Email.
urlstringNotification receiver's URL. Notification will be sent to this URL if type is set to Callback.
methodstringHTTP method for Callback. JSON, POST or GET
emailstringNotification receiver's Email. Notification will be sent to this URL if type is set to Email.

send_notify Object

PropertyTypeDescription
typestringType of the notification. Type can be None, Callback or Email.
urlstringNotification receiver's URL. Notification will be sent to this URL if type is set to Callback.
methodstringHTTP method for Callback. JSON, POST or GET
emailstringNotification receiver's Email. Notification will be sent to this URL if type is set to Email.

timeout_service Object

PropertyTypeDescription
timeout_servicestringType of the timeout. Type can be None, Forward, Voicemail or Voice2Email.
timeout_idstringTimeout service ID.
timeout_secondsstringNumber of seconds after call goes to timeout service. Default it 25 seconds.
voice2email_greetingstringVoice2Email greeting.

busy_service Object

PropertyTypeDescription
busy_servicestringType of the Busy service. Type can be None or Forward.
busy_idstringBusy service ID.

directory_settings Object

PropertyTypeDescription
first_namestringFirst Name to be displayed in Directory.
last_namestringLast Name to be displayed in Directory.
showstringShow device in directory or not. A boolean flag.
speed_dialstringSpeed Dial for the directory if different from regular speed dial.

forwardall_settings Object

PropertyTypeDescription
phonenumberstringPhonenumber to forward all calls.
start_timestringForwardAll start time in HH:mm format.
end_timestringForwardAll end time in HH:mm format.

🚧

Callbacks

Please refer callback documentation for more information at Callbacks