Reference8:Phone Configuration API

FIXME: Work in progress, still very incomplete

Starting with v8 a new Web User Interface has been implemented to configure the Phone. The same interface can be used by applications for configuration. The interface is based on the mechanism used by web forms. This means a string containing a list of named arguments is sent to the Phone/PBX and the Phone/PBX returns an XML document.

There are different ways to send the argument list to the Phone/PBX: HTTP GET, HTTP POST, SOAP.

Transport Methods

HTTP GET

The arguments are sent as part of the URL. The URL to be used has the following form.

If sent to the PBX:

<ip>/<PBX-Entity>/PHONE/mod_cmd_login.xml?argument1=value1&argument2=value2&...

if sent to the Phone:

...

HTTP POST

to be done

SOAP

to be done

Common Arguments

In general the sequence of the arguments is not important except in some cases in which a list of configuration items can be sent, with each item being described by multiple arguments.

cmd

The argument cmd is used to identify which command shall be executed. Depending on the argument cmd other arguments are available.

xsl

With this argument a reference to an XSL file is inserted into the returned XML file.

guid

A GUID as hex string to identify the object for which this config is stored. If * is set, the cn is used to identify the object instead.

cn

The Long Name used to identify the object if guid is set to *.

cmd=fkey-edit

fkey_id	A numeric id of the function key
fkey_type	A string identifying the type of the function key. Depending on the type different arguments are available
label	The idle label displayed on the function key if possible

cmd=reg-edit-general

pref.callwait

Call Waiting Mode: dfl/once/mute/off