fritzbox.js 2.0.0 | Documentation

fritzbox.js

2.0.0

fritzDect ▸
- Static members
- .toggleSwitch
- .getSmartDevices
fritzFon ▸
- Static members
- .markTamMessageAsRead
- .getActiveCalls
- .CallMonitor
- .getPhonebook
- .dialNumber
- .getCalls
- .getTamMessages
- .downloadTamMessage
fritzLogin ▸
- Static members
- .getSessionId
fritzSystem ▸
- Static members
- .getVersionNumber
- .getVersion
fritzWlan

Need help reading this?

fritzDect

Fritz!Box DECT and Smart Home functions.

fritzDect

Static Members

▸ toggleSwitch(deviceId, value, options)

Toggle a Fritz DECT switch on or off.

toggleSwitch(deviceId: integer, value: integer, options: Object): Object

Parameters

deviceId (integer) The Id of the smart home device.

value (integer) Turn on (1) or off (0).

options (Object) FritzBox.js options object.

Returns

Object: An object with message and deviceId.

▸ getSmartDevices(options)

Get all smart devices and groups.

getSmartDevices(options: Object): Array

Parameters

options (Object) FritzBox.js options object.

Returns

Array: An array of all found smart devices.

fritzFon

Fritz!Fon functions.

fritzFon

Static Members

▸ markTamMessageAsRead(messageId, options, tamId = 0)

Mark a message as read.

markTamMessageAsRead(messageId: number, options: Object, tamId: number?): boolean

Parameters

messageId (number) The Id of the message to mark as read.

options (Object) FritzBox.js options object.

tamId

(number?
            = 0)

The Telephone Answering Machine Id

Returns

boolean: Returns true when the message was marked as read.

▸ getActiveCalls(options)

Get any active calls.

getActiveCalls(options: Object): Array

Parameters

options (Object) FritzBox.js options object.

Returns

Array: Returns an array of active calls.

▸ CallMonitor(options)

Receive events for incoming and outgoing calls.

Enable the callmonitor on your Fritz!Box by dialing #96*5* and disable with #96*4* Set options.callmonitorport to 1012 or a custom port.

This is an implementation of Thorsten Basse's Fritz!Box Call Monitor

CallMonitor(options: Object): EventEmitter

Parameters

options (Object) FritzBox.js options object.

Returns

EventEmitter: Returns an event emitter for you to catch events with.

▸ getPhonebook(phonebookId?, options)

Download the given telephone book.

getPhonebook(phonebookId: number?= 0, options: Object): Array

Parameters

phonebookId (number?= 0) Id of the phonebook to use.

options (Object) FritzBox.js options object.

Returns

Array: Returns an array of contact objects.

▸ dialNumber(phoneNumber, options)

Dial the given number.

dialNumber(phoneNumber: number, options: any): Object

Parameters

phoneNumber (number) The phonenumber to dial, including any extension.

options (any)

Returns

Object: Returns an object with a message.

▸ getCalls(options)

Get the history of telephone calls.

getCalls(options: Object): Array

Parameters

options (Object) FritzBox.js options object.

Returns

Array: Array of telephone call history.

▸ getTamMessages(options)

Get Telephone Answering Machine (TAM) Messages.

getTamMessages(options: Object): Array

Parameters

options (Object) FritzBox.js options object.

Returns

Array: Array with TAM messages.

▸ downloadTamMessage(messagePath, localPath, options)

Download a message from the Telephone Answering Machine (TAM).

downloadTamMessage(messagePath: string, localPath: string, options: Object): Object

Parameters

messagePath (string) The remote file path of the message.

localPath (string) The local file path to save the message to.

options (Object) FritzBox.js options object.

Returns

Object: Returns an object with a message.

fritzLogin

Static Members

▸ getSessionId(options)

getSessionId(options: Object): string

Parameters

options (Object) FritzBox.js options object.

Returns

string: Returns a sessionId if successful.

fritzSystem

Static Members

▸ getVersionNumber(options)

Get the version of a Fritz!Box without authentication.

getVersionNumber(options: Object): number

Parameters

options (Object) server protocol

Returns

number: The Fritz!OS version cast as an integer (e.g. 683 )

▸ getVersion(options)

Get the version of a Fritz!Box without authentication.

getVersion(options: Object): string

Parameters

options (Object) FritzBox.js options object.

Returns

string: The Fritz!OS version as a string (e.g. '06.83' )

fritzbox.js

fritzDect

fritzFon

fritzLogin

fritzSystem

fritzWlan