Date: Thu, 28 Mar 2024 11:52:12 +0100 (CET) Message-ID: <677060626.3.1711623132236@teamwork> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_2_538630972.1711623132233" ------=_Part_2_538630972.1711623132233 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
When the VoIP phone contacts the Gigaset server, in order to get a= ll the necessary configuration data, the redirection server su= pplies the URL of the provisioning server which is responsible for providin= g the VoIP phone with the provider data (SIP account).
To enable auto-provisioning (i.e. the end-user does not need to se= lect the provider manually) the provisioner must add the redirection inform= ation for the VoIP phones to the redirection database.
Access is secured via HTTP digest 12 digits username and MAC-ID.
To add the redirection data to the redirection database, Gigaset provide= s a web user interface for provisioners.
You need a user account (user name and password) which has to be provide= d by Gigaset Communications.
1. Open the web user interface:
http://prov.gigaset.net or https://prov.giga= set.net/Editor/#loginPage
2. Login using the user name and password provided by Gigaset.= strong>
3. Select the option Redirect portal.
Example: http://provider.com/xml/%MACD.xml
When using Maxwell 10, connection to the server and loading the XML conf= iguration data takes longer then with other Gigaset devices. The reason is = that other Android processes also need to be started after boot.
Connection to Redirect server 50 seconds after boot.
Activate new xml configuration 2 minutes after boot.
Maxwell B/2/3/4 have an option implemented that you can add the HTTP dig= est username and password in the URL.
Example: http://provider.com/xml/%MAC= D.xml
You want to add an HTTP digest username and password for your own server= .
New example: http(s)://<username>:<password>@provider.com/xml/%MACD.xml
<?xml version=3D'1.0'?> <methodCall> <methodName>autoprov.registerDevice</methodName> <params> <param> =09 <value> =09 <string>7C2F80820EC0-55DF</string> =09 </value> =09 </param> =09 <param> =09 <value> =09=09<string>http://172.29.0.103/plainxml/42/2/xml/7C2F80820EC0.xml&= lt;/string> =09 </value> =09 </param> =09 <param> =09 <value> =09=09<string>Daryna</string> =09 </value> =09 </param> =09</params> </methodCall>
Next server's answers are possible:
Return value (1) (Boolean) 1 | 0 1 =3D true, 0 =3D false Return value (2) (String) if true: OK: password if false: mac_already_in_use mac_invalid url_invalid name_invalid
Usage of XML file instead is also possible:
<?xml version=3D'1.0'?> <methodCall> <methodName>autoprov.deregisterDevice</methodName> <params> <param> <value> <string>7C2F80820EC0-55DF</string> </value> </param> </params> </methodCall>
XML template for the deregistration can be downloaded here:
After XML file was constructed, it is necessary to upload it, in the sam=
e way as it was described previously. Different
server's answers are possible:
Return value (1) (Boolean) 1 | 0 1 =3D true, 0 =3D false Return value (2) (String) if true: OK if false: mac_not_found mac_invalid
Register device list
Let's assume that at once, you=
may need to register not a single device, but a list containing several of=
them,
XML structure for such a case will look like this:
<?xml version=3D'1.0'?> <methodCall> <methodName>autoprov.registerDeviceList</methodName> <params> <param> <value> <array> <data> <value><string>7C2F80820EC0-55DF</string></va= lue> <value><string>7C2F80208295-1910</string></va= lue> </data> </array> </value> </param> <param> <value><string>http://172.29.0.103/plainxml/%DVID/xml/%= MACD.xml</string></value> </param> <param> <value><string>Daryna</string></value> </param> </params> </methodCall>
XML template can be downloaded here:
As previously, several server's answers are possible:
Return value (1) (Boolean) 1 | 0 1 =3D true, 0 =3D false Return value (2-n) (String) if true: OK: Password if false: mac_invalid url_invalid name_invalid mac_already_in_use mac_not_exist
The next picture shows, 'True' server's answer:
Deregistration of the list of devices
Let's a=
ssume that at once, you may need to deregister not a single device, but a l=
ist containing several of them.
XML structure for such a case will look like this: = span>
<?xml version=3D'1.0'?> <methodCall> <methodName>autoprov.deregisterDeviceList</methodName> <params> <param> <value><array> <data> <value><string>7C2F80820EC0-55DF</string></valu= e> <value><string>7C2F80208295-1910</string></valu= e> </data> </array></value> </param> </params> </methodCall>
XML template can be downloaded here:
Next server responds are possible:
Return value (1) (Boolean) 1 | 0 1 =3D true, 0 =3D false Return value (2-n) (String) if true: OK if false: mac_invalid mac_not_found
An example of real server responds, while only one of the provided= MAC =E2=80=93 ID was invalid:
List devices
The purpose of this request is to get:<=
/p>
General structure of the XML =E2=80=93 file for such a case looks like t= his:
<?xml version=3D'1.0'?> <methodCall> <methodName>autoprov.listDevices</methodName> <params> </params> </methodCall>
XML template can be downloaded here:
As in the previous cases, several server's responses are possible:
Return value (0-n) (Object[]) [MAC,NAME,URL,DATE]
On the picture below, you can see the result of the real server re= spond after valid XML =E2=80=93 file uploading:<= /span>
Here, by pressing the =E2=80=9CResult=E2=80=9D button marked by re=
d square, you can get XML =E2=80=93 file containing the same information as=
presented on the picture, in other words, XML =E2=80=93 f=
ile, containing =E2=80=93 MAC =E2=80=93 address, provider name, URL and dat=
e of registration.
5.1 List devices name
This is an a sub-option of the method pres=
ented above. Basically, you will get the same information (after uploading =
your XML =E2=80=93 file),
but for a specific provider.
General structure of the XML =E2=
=80=93 file:
<?xml version=3D'1.0'?> <methodCall> <methodName>autoprov.listDevices</methodName> <params> <param> <value><string>Daryna</string></value> </param> </params> </methodCall>
General structure of the XML =E2=80=93 file:
Server response description:
Return value (0-n) (Object[]) [MAC,NAME,URL,DATE]
The result of usage valid XML -file after successful uploading (on= ly one provider was specified):
Check device(s)
This option allow its request=
er to check either the device is registered or not. Along with information&=
nbsp;that
device is registered, requester will get a provid=
er name, URL and date of registration.
General structure of=
an XML file will look like this:
<?xml version=3D'1.0'?> <methodCall> <methodName>autoprov.checkDevice</methodName> <params> <param> <value><string>7C2F80820EC0-55DF</string></value> </param> </params> </methodCall>
XML template can be downloaded here:
Several server's responses are possible:
Return value (1) (Boolean) 1 | 0 1 =3D true, 0 =3D false Return value (2) (String) if true: [MAC] if false: mac_not_found mac_invalid Return value (3) if true: [NAME] Return value (4) if true: [DATE] Return value (5) if true: [URL]
Below, you can see the real server respond based on the valid MAC = =E2=80=93 ID:
The real server respond based on the invalid MAC =E2=80=93 ID:
Usage of XML-RPC script
Registration of the single device using ap-client.py script
First thing which has to= be done (for this steps and all the steps below):
After all the described steps above were done, please run 1st command fo= r the device registration:
python ap-client.py Auth-Name Auth-Pass prov.gigaset.net autoprov.regi= sterDevice s:MAC-ID s:URL s:Provider-Name
In case of the successful registration, server will answer:=
And in prov.gigaset.net your device will be re= cognized as the registered one:
Check - status
In ord= er to check status of the device, you have to run next command:
python ap-client.py Auth-Name Auth-Pass prov.gigaset.net autoprov.list= Devices s:Provider-Name
On the picture below, command in use within server response can be= seen:
Device deregistration
In order to = deregister device, you have to run next command:
python ap-client.py Auth-Name Auth-Pass prov.gigaset.net autoprov.dere= gisterDevice s:MAC-ID
On the picture below, command in use within server response can be= seen:
Deregistration of the list of devices
In order to deregist=
er list of the devices, you have to run next command (specify here all MAC-=
ID which you want to deregister):
python ap-client.py Auth-Name Auth-Pass prov.gigaset.net autoprov.dere= gisterDeviceList sl:MAC-ID1,MAC-ID2,MAC-IDN
On the picture below, command in use within server response can be= seen:
Registration of the list of devices
In order to register list =
of the devices, you have to run next command (specify here all MAC-ID which=
you want to register):
python ap-client.py Auth-Name Auth-Pass prov.gigaset.net autoprov.regi= sterDeviceList sl:MAC-ID1,MAC-ID2,MAC-IDN s:URL, s:Provider-Name
On the picture below, command in use within server response can be= seen:
Dependent on the DX800 variant, it can be that the redirect server= option is disabled. This can only be enabled via special configuration, fo= r this you need a patch. The patch is based on the variant and contains the= following settings to enable redirect server.
DX800 enable redirect
BS_IP_Data1.ucB_HAS_PROVISIONING_CODE=3D1
BS_IP_Data1.ucB_SHOW_PROVISIONING_CODE_IN_HS=3D1
BS_IP_Data1.ucB_AUTOPROVISIONING=3D0
BS_IP_Data1.ucI_AUTOPROVISIONING_STYLE=3D0
BS_IP_Data1.ucB_AUTO_UPDATE_PROFILE=3D1
BS_IP_Data3.ucI_ONESHOT_PROVISIONING_MODE_1=3D1
BS_IP_Data1.aucS_AUTOPROVISIONING_CODE=3D0x34,0x34,0x34
Via the restore option, you can activate the patch below. If you variant= is not listed you need to request this from Gigaset.