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"
}
}
| Property | Type | Description |
|---|
| id | string | Unique identifier of device. |
| name | string | Name/Label for device. |
| fonenumber | string | 10-digit outbound caller id for device. |
| mac_address | string | Mac address of device. |
| type | string | Type for device. Please check Supported Devices for the list. |
| speed_dial | string | 1 to 6 digit Extension/SpeedDial for device. |
| call_recording | string | Call recording flag for device. default, yes, no, inbound, outbound or ondemand |
| e911location_id | string | Unique identifier of e911location service. |
| areacode | string | 3-digit local are code. |
| qr_code | string | QR code if device is a SoftPhone or a WebRTC device. Otherwise NULL. |
| ring_simultaneously | string | 10-digit phone number. |
| receive_notify | object | Device's call received notification setting. |
| send_notify | object | Device's call initiated notification setting. |
| host_type | string | Host type can be static or dynamic. Only Trunk Device requires this parameter |
| host_ip | string | Host IP is used if host_type is static. Only Trunk Device requires this parameter |
| host_port | string | Host Port is used if host_type is static. Only Trunk Device requires this parameter |
| Property | Type | Description |
|---|
| type | string | Type of the notification. Type can be None, Callback or Email. |
| url | string | Notification receiver's URL. Notification will be sent to this URL if type is set to Callback. |
| method | string | HTTP method for Callback. JSON, POST or GET |
| email | string | Notification receiver's Email. Notification will be sent to this URL if type is set to Email. |
| Property | Type | Description |
|---|
| type | string | Type of the notification. Type can be None, Callback or Email. |
| url | string | Notification receiver's URL. Notification will be sent to this URL if type is set to Callback. |
| method | string | HTTP method for Callback. JSON, POST or GET |
| email | string | Notification receiver's Email. Notification will be sent to this URL if type is set to Email. |
| Property | Type | Description |
|---|
| timeout_service | string | Type of the timeout. Type can be None, Forward, Voicemail or Voice2Email. |
| timeout_id | string | Timeout service ID. |
| timeout_seconds | string | Number of seconds after call goes to timeout service. Default it 25 seconds. |
| voice2email_greeting | string | Voice2Email greeting. |
| Property | Type | Description |
|---|
| busy_service | string | Type of the Busy service. Type can be None or Forward. |
| busy_id | string | Busy service ID. |
| Property | Type | Description |
|---|
| first_name | string | First Name to be displayed in Directory. |
| last_name | string | Last Name to be displayed in Directory. |
| show | string | Show device in directory or not. A boolean flag. |
| speed_dial | string | Speed Dial for the directory if different from regular speed dial. |
| Property | Type | Description |
|---|
| phonenumber | string | Phonenumber to forward all calls. |
| start_time | string | ForwardAll start time in HH:mm format. |
| end_time | string | ForwardAll end time in HH:mm format. |
🚧
Callbacks
Please refer callback documentation for more information at Callbacks
