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"
  }
}

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.

🚧

Callbacks

Please refer callback documentation for more information at Callbacks