innovaphone wiki - User contributions [en]

Howto15r1:Configure User Presence Sync by Connector for Microsoft365

2026-02-20T11:17:35Z

Maikschlz: System requirements regarding the password added

==Applies To==
This information applies to
Connector for Microsoft 365 from version 15r1

==More Information==

This article outlines a configuration scheme for Connector for Microsoft365 functionality. 
In preparation, you first will need to configure two Applications in your Azure Portal (one for each direction). 
After that, you will install the App in your Application Platform, and configure everything.

===System Requirements===

* Licenses '''innovaphone Connector for Microsoft 365''' per user who wants to use the innovaphone myApps Connector for Microsoft 365.
* '''account in Azure Portal of Microsoft''' (for each of the technical communication users, no permission role needed) 
** Each communication user must have a Teams license applied, more infos can be found [https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/eligible-teams-licenses here] 
** Each communication user can be used to subscribe the presence of up to 650 users. (If you want to synchronize more than 650 users, you will need a multitude of communication users)
** Must '''not''' have multi factor authentication activated
** the password must not contain a percent sign (exclamation marks are OK, others are unknown)
* Must have access from the internet to your App Platform
** This can be done by using a reverse proxy or other firewall
* The public endpoint '''must have ''' a '''valid, public signed certificate''' (in order to make a trusted SSL connection from the Azure cloud to the Application Platform possible)
** A valid certificate is required in all involved network entities - at least in the App Platform and if used in the Reverse Proxy; to ensure transmission of MS365 HTTPS POST requests to the app service in order to send notifications.
* Admin account for Azure Portal (only necessary for granting needed permission for registered app during setup)

==Installation==

===Configuration in Azure Portal===
====Create an App for syncing Teams to PBX====

* '''In the Azure Portal of Microsoft you have to add an app registration'''
* '''You only have to give a name for the app'''

[[Image:App_Registration_Connector_for_Microsoft365.png|thumb|none|600px|App Registration|app_registration_connector_for_microsoft365.png/]]

* '''Switch to the authentication on the left'''
* '''You only have to configure allow public client flow'''

[[Image:Authentication_Connector_for_Microsoft365.png|thumb|none|600px|authentication_connector_for_microsoft365.png/]]

* '''Switch to api permissions on the left'''
* '''You have to configure delegated permissions (User.Read.All and Presence.Read.All) as shown in the picture'''
* '''Grant access to the api permissions, if not possible you have to ask an admin'''

[[Image:Azure_Select_Api-Permission.png|thumb|none|600px|azure_select_api-permission.png/]]

[[Image:Azure_Select_Api-Permission_Delegated.png|thumb|none|600px|azure_select_api-permission_delegated.png/]]

[[Image:APIPermission_Connector_for_Microsoft365.png|thumb|none|600px|apipermission_connector_for_microsoft365.png/]]

With these configurations you can configure the Connector for Microsoft365

* '''Client ID as shown in the picture'''
* '''Tenant ID as shown in the picture'''
* '''User'''
* '''Password'''

[[Image:Overview_Connector_for_Microsoft365.png|thumb|none|600px|overview_connector_for_microsoft365.png/]]

====Create an App for syncing PBX to Teams====

* '''In the Azure Portal of Microsoft you have to add a new app registration'''
* '''In the picture you can see that we have 2 values after that which we can use for the configuration of the app'''

[[Image:Overview_Connector_for_Microsoft365_Sync_to_Teams.png|thumb|none|600px|overview_connector_for_microsoft365_sync_to_teams.png/]]

* '''Switch to Certificates & Secrets on the left'''
* '''You only have to configure a client secret and save the value for the configuration of the app'''

[[Image:Authentication_Connector_for_Microsoft365_Sync_to_Teams.png|thumb|none|600px|authentication_connector_for_microsoft365_sync_to_teams.png/]]

* '''Switch to api permissions on the left'''
* '''You have to configure application permission (Presence.ReadWrite.All) as shown in the picture'''
* '''Grant access to the api permissions, if not possible you have to ask an admin'''

[[Image:Azure_Select_Api-Permission.png|thumb|none|600px|azure_select_api-permission.png/]]

[[Image:Azure_Select_Api-Permission_Application.png|thumb|none|600px|azure_select_api-permission_application.png/]]

[[Image:APIPermission_Connector_for_Microsoft365_Sync_to_Teams.png|thumb|none|600px|apipermission_connector_for_microsoft365_sync_to_teams.png/]]

===installation and configuration of the App ===
==== Install the App with the Settings App - AP app installer plug-in ====
[[File:Ap_app_installer.png|ap_app_installer.png/]]

Go to the Settings App and open the '''"AP app installer"''' plugin. On the right panel, the App Store will be shown. ''Hint : if you access it for the first time, you will need to accept the "Terms of Use of the innovaphone App Store"''
* In the search field located on the top right corner of the store, search for '''"Connector for microsoft 365"''' and click on it
* Select the proper firmware version, here '''"v15"''' and click on install
* Tick "I accept the terms of use" and continue by clicking on the install yellow button
* Wait until the install has been finished
* Close and open the PBX manager to refresh the list of the available coloured AP plugin
* Click on the '''"AP microsoft365"''' and click on '''" + Add an App"'''
* The '''"Name"''' display name field ''(all characters allowed)'' and the '''"SIP"''' administration field ''(no spaces, no capital letters)'' are prefilled, you can leave them as they are.
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good

====Add the admin app to a user or a template====
To be able to configure the connector app, you need users to have access to the admin app. 
You can achieve this by adding the app to a user, or to a template. 
In this Howto - as an example - we will add the app to the <code>Config Admin</code> template. 
* In the Settings App
# select the <code>Templates</code> tile
# click on the <code>Config Admin</code> template
[[Image:Microsoft365_template_1.png|thumb|none|600px|microsoft365_template_1.png/]]
* In the <code>Config Admin</code> template
# open Apps
# Check the <code>app name</code> checkbox
# Save the changes
[[Image:Microsoft365_template_2.png|thumb|none|600px|microsoft365_template_2.png/]]

====Configure the connector with the admin app====
Now your admins (designated groups or configured user) should have access to the connector admin app. 
* A user with access to the app can now see a new tile in the '''All Apps''' area
* The name depends on the configured <code>app name</code> from the PBX Manager plugin
[[Image:Microsoft365_admin_app_1.png|thumb|none|600px|microsoft365_admin_app_1.png/]]
=====Synchronization from Teams to the PBX=====
* First you will need to configure the inbound sync from Teams to PBX
** Configuration
**# '''Master PBX''' - Set the name of your Master PBX ('''Not full DNS name, really just only the PBX name''') Good: [pbx] Bad: [pbx.domain.tld]
**# '''ClientIDSynctoPbx''' - Please insert the Application ID (Client ID) from Azure Portal from the in preparation created Teams to PBX app
**# '''TenantSynctoPbx''' - Please insert the Directory ID (Tenant) from Azure Portal from the in preparation created Teams to PBX app
**# '''Notification URL''' - You need to specify the address Microsoft can send presence updates to.
**## You need to make sure that you define a URL where you can reach your App Platform from the public internet <code>public.dns</code>
**## Next you need the domain you have configured in the app instance before (3.2.2) <code>your.domain</code>
**## Next you need the name of the instance you have configured before (3.2.2) <code>microsoft365</code>
**## The URL will always be terminated by <code>subscriptions</code>
**##* <code>https://public.dns/your.domain/microsoft365/subscriptions</code>
*** Save your changes
*** [[Image:Microsoft365_admin_app_2_14r2.png|thumb|none|600px|microsoft365_admin_app_2_14r2.png/]]
** Manage Teams accounts
**# Click on Add Teams account
**# Enter username (Azure Portal account in email format)
**# Enter password
**# Click on the check mark
**# Make sure to add an Azure Portal communication user for each 650 user you want to subscribe
*** [[Image:Microsoft365_admin_app_2_14r2_user.png|thumb|none|600px|microsoft365_admin_app_2_14r2_user.png/]]
* After successful configuration and subscription, the Microsoft services will connect to the specified ''Notification URL'' for presence and line state updates.
* For this to work, it is important to make sure that the specified ''Notification URL'' is reachable from the Microsoft services, meaning from the public internet.
'''It can take up to 10 Minutes until all check marks are green, and the sync is working'''

=====Synchronization from the PBX to Teams=====
* For the outbound synchronization you select from PBX to Teams in the admin app
# '''ClientIDSynctoTeams''' - Please insert the Application ID (Client ID) from Azure Portal from the in preparation created PBX to Teams app
# '''TenantSyncto Teams''' - Please insert the Directory ID (Tenand) from Azure Portal from the in preparation created PBX to Teams app
# '''ClientSecretSynctoTeams''' - Please insert the shared secret from the in preparation created PBX to Teams app
[[Image:Microsoft365_admin_app_3_14r2.png|thumb|none|600px|microsoft365_admin_app_3_14r2.png/]]
* For the sync direction from PBX to Teams, the app itself needs visibility permissions (presence, on-the-phone) for the users who are should be synced to Teams. The configuration tag is visibility for each user object.

==Related Articles==
[[Reference15r1:Concept App Service Connector for Microsoft 365|Concept App Service Connector for Microsoft 365]] 
[[Howto15r1:Configure Calendar Presence Sync by Connector for Microsoft365]]

[[Category:Howto|{{PAGENAME}}]]

Reference14r2:Concept App Service Devices

2024-08-01T06:56:23Z

Maikschlz:

[[Category:Concept|Apps]]
The App Service Devices is an App Service which can be installed on an innovaphone App Platform. It is used to administrate the innovaphone devices which belong to the whole installation.
== Applies To ==

* innovaphone PBX from version 13r1

== Apps ==

=== Devices App (innovaphone-devices) ===
This is the standard UI App for Devices.

Parameters:

;Websocket: to publish the com.innovaphone.devicesui-API, which can be used to link directly to devices (which is done e.g. inside the Events app)

=== Devices API (innovaphone-devices-api) ===
This is a hidden App, which provides the Devices API (com.innovaphone.devices). This API can be used to find and communicate with devices which are registered to the Devices App.

Additionally it acts as a provider of the Search API (com.innovaphone.search). So you can find devices and domains in other apps like the Search App.

Parameters:

;Hidden: DevicesApi must be a hidden App
;Websocket: to get the URL of the Devices App itself which is used for provisioning

== PBX Manager Plugins ==

=== Devices ===

With the Devices plugin App objects can be created, edited and deleted for Devices and the Devices API on the PBX.

== Concepts ==
All innovaphone hard phones and gateways starting from version 13r1 can establish a registration inside the Devices App and therefor administrative tasks can be performed through the App.

=== Domains ===

In a hosted environment, it might be needed to add multiple domains to the Devices App. 
After the initial installation of Devices through Install, you have administrative rights and can add more domains.

==== Administrative rights ====
You have administrative rights if the configured PBX App object for Devices uses the password of the instance which is configured in the Manager App and the PBX uses the same domain as this instance.

==== Domain local rights ====
You have just rights to a certain domain if the configured PBX App object for Devices uses the domain password which can be configured in Devices for each domain and the PBX uses the same domain name as configured in Devices.

==== Assign rights to other domains ====
Domains can gain access to other domains by configuring these access rights in the Devices App.

==== Deploy passwords and access rights ====
During install, a domain is created inside the Devices App. There is a checkmark Deploy the domain password on all devices which is set by default and which is the same as the administrative password.
If you change the domain password, all passwords on all administrative devices and app platforms which are connected to this domain will be also changed. 
Since 13r3SR7/12r2SR25: devices which are auto provisioned or provisioned through the Profile/Users Admin App will get a random password instead of the domain password.
If you add a phone device manually to a domain inside the Devices App, this phone device will also get a random password. Other device types added manually or devices added with a provisioning code which has been created within the Devices App directly, will get the domain password instead. 
 
This will also set the manager password and the SSH passwords of App Platforms. 
 
The clear text random passwords can be requested and viewed in the settings of a device in the Devices App.

Attention: If you untick the '''Deploy administrative devices passwords''' checkmark, the password won't be deployed anymore, but also not reconfigured to the default password!

Attention: After each reconnect of a client, the password will be deployed again.
This means, if the checkmark is set and you set another password somewhere else (e.g. under General::Admin),
this password will be just valid until the next reboot or reconnect to the Devices App!

;Create new random passwords
You can rollout new random passwords by unticking the '''Deploy administrative devices passwords''' checkmark and ticking it again. 

;Devices with multiple domains (Cloud)
In a hosted environment, you can use the Devices App with multiple domains. The corresponding instance of Devices has a configured domain and an instance password set inside the manager. 

The hosting PBX has a domain inside Devices with a specific password. 
If this domain name matches the instance domain of the Devices instance and the password matches either the instance password or the domain password, you will be logged in as admin and have access to all domains. 

Each newly created domain has its own password inside Devices. If you create an App Object inside a PBX with this domain and the password of this domain (inside Devices), you will just have access to this single domain. 

Devices also has the possibility to grant access to other domains for a specific domain.

=== Device connections ===
The Devices registration is done through a websocket connection to the webserver of the App Platform and the Devices instance (standard HTTP/s port). 
The URL used can be configured manually under [http://wiki.innovaphone.com/index.php?title={{NAMESPACE}}:General/Devices_Registration Devices Registration] or through a new provisioning mechanism. 
 
A binary protocol is used to transfer information between the device and the devices App. The MAC address is the unique key to identify a device. 
 
If a device is added to a domain in Devices, the device gets a unique random password. Without such a password, a device shows up as '''unassigned''' in the Devices app.
This is also the case after a long reset or when the device lost its configuration. 
 
In such a case, the device has to be manually added again to a domain or it has to be provisioned again.

If a device is not assigned to a domain or provisioning category, it won't receive any configurations.

==== Devices Registrations ====
See [http://wiki.innovaphone.com/index.php?title={{NAMESPACE}}:General/Devices_Registration Devices Registration]

==== Second Devices Registration URL ====

The firmware has a second SYSCLIENT2 module, which can be configured to point to a different Devices instance and the AP Manager also has a second Devices Registration URL. 
 
If you use this configuration option, you should take care and consider:

* if the Devices domain from the second configuration provides a password for all devices, the password is ignored, as it would lead to inconsistend passwords otherwise (from 13r1 SR12 on)
* the Devices domain from the second configuration should not provide Devices Configurations or Update Jobs as these might collide with configurations from the first Devices instance!

Generally, only one of the two ''Devices'' App instances connected to the device must apply changes to the device.

We strongly discourage the usage of this second configuration option due to unexpected behaviour if incorrectly used!
Never use the second URL if you use software or hardware rental!

==== Device information ====

The following data is transferred:
* MAC address
* device type (e.g. IPVA, AppPlatform, IP112)
* IP addresses (IPv4, IPv6)
* version (not searchable)

You can also search for this data inside the devices tab in the App.


=== Provisioning ===
Devices can be added by provisioning (both phones and gateways).
The standard online provisioning looks like this:
* a user or administrator creates a provisioning code in the Devices or Users App (this stores the Devices URL on the provisioning server side)
* a device with 13r1 or newer is connected to the network after a long reset
* the provisioning code has to be entered within one hour (after one hour, the Update URL isn't polled anymore)
* the device sends this code to config.innovaphone.com and retrieves the Devices URL
* the device connects to the Devices URL and is added to the domain where the code has been created

There is also an [http://wiki.innovaphone.com/index.php?title={{NAMESPACE}}:Concept_Offline_Provisioning offline provisioning mode]. 
There is also an [http://wiki.innovaphone.com/index.php?title={{NAMESPACE}}:Concept_Provisioning#Automatic_provisioning automatic provisioning mode].

Note: provisioning is cancelled if the device already belongs to another domain in the same Devices instance! This prevents the unauthorized move of a device between different domains.

==== Devices Registration URL ====

The Devices Registration URL which is set through the provisioning process, always starts with '''wss'''. This is not dependent anymore on the App URL which is configured inside the PBX Devices App object.

=== Updates ===
The Devices App can be used to rollout updates. 

==== JSON files ====
The update files have to be acccessible on a webserver without authentication and two json files are used to describe the used firmware and apps. 
You can either use the standard innovaphone App Store for these files or your own local webserver. 

==== Update jobs ====
You can configure several update jobs with different categories to organize your updates. 
Update jobs are always sequentially processed and inside one update job, just '''20''' devices are updated at the same time.

==== Device update check after the update job has been already executed====
If a device goes online, the newest suitable update job is searched for this device (depending on the categories). 
If an update job is found, the update is just performed, if there has been '''no''' successfull update for this device in this job before and the version does not match (simply string compare).

====Update errors====
If an update fails, the Devices App shows an error. You may have to enable further tracing on the updated device itself to find out the reason of the failure. 
 
* on a gateway/phone add a trace flag to the UP1 and HTTPCLIENT0 module and take a look at the events which may already tell you the reason
* on an App Platform, enable the App and HTTP Client trace flag on the manager

An update job is retried '''two''' times if updates inside this job failed. The retry is done '''ten''' minutes after the update job finished previously.

====innovaphone myApps====
The path to the App Store and the used innovaphone myApps version is updated to the version of the gateway on gateways with an enabled PBX after a successfull update. 
This configuration can be found [http://wiki.innovaphone.com/index.php?title={{NAMESPACE}}:PBX/Config/myApps here]

Inside the configuration on an update job, the flag "Do not update myApps launcher software" disables the update of the innovaphone myApps version inside PBXes.

=== Backups ===
The Devices App can be used to backup the configuration and data of Apps and devices. 

====Webserver requirements====
Backups are stored on a webserver with or without Digest/Basic authentication and with the '''webdav PUT''' method.

====Backup jobs====
Backup jobs are executed sequentially. Inside one backup job, just '''20''' backups are performed at the same time.

====Phones or gateways====
The configuration file is stored. Therefor the Devices App tells the device to store the configuration with a !mod cmd UP0 /sync prot URL.

====Apps on an App Platform====
The databases of all existing instances and the manager are stored. 
Each installed App Service can have multiple instances and each App instance has its own database. 
A database contains '''both''' configuration and data of an App instance! 
The manager database contains the webserver certificate and further manager related configuration settings.

The Devices App establishes a websocket connection to the manager and tells the manager where to store the backups. 
The manager on the backuped App Platform itself performs the HTTP requests to store the files.

====Backup errors====
If a backup fails, the Devices App shows an error. You may have to enable further tracing on the backuped device itself to find out the reason of the failure.

* on a gateway/phone add a trace flag to the UP1 and HTTPCLIENT0
* on an App Platform, enable the App and HTTP Client trace flag on the manager

=== Restore ===
====Phones or gateways====
Just as always under [http://wiki.innovaphone.com/index.php?title={{NAMESPACE}}:Administration/Upload/Config Upload Config].

====Apps====
The App Service itself has to be installed on the App Platform prior restoring of a single instance. 
The restoring is done in the Manager App on the App Platform itself. 
The intance settings, the configuration and data are restored in a single process.

=== Device Configurations ===

You can define several device configurations. These configurations are either applied to all devices inside this domain or to selected categories. 
Configurations are applied on creation and on every reconnect of a matching device.

==== Transfer checkmarks ====

Some configuration options have a specific checkmark to enable the transfer of the option. 
 
* Checkmark disabled:
** configuration option field(s) are disabled
** option values are '''not''' transferred at all
* Checkmark enabled:
** configuration option field(s) are enabled
** option values are transferred, even if field values are empty

==== Expert configuration ====

The expert configuration can be used to configure different settings which are not available inside the other device configurations. 
You can use the standard syntax of an update server script (see [[ {{NAMESPACE}}:Concept_Update_Server | Concept Update Server ]] for a general overview and the section on [[Howto:PHP_based_Update_Server_V2#Hints_for_writing_your_update_snippets | Hints for writing your update snippets ]] (note that the remainder of this article relates to the now deprecated old mechanism, so please disregard the rest)). 
 
Some hints:
* the expert configuration is just executed once after a device restarted and on change of the expert configuration itself
* the expert configuration is executed after all other device configuration types, so that you can override changes
* to make configuration changes effective, you may also need to issue a final ''config write'', ''config activate'' and ''iresetn'' command (see the [[ {{NAMESPACE}}:Concept_Update_Server#Check_command | ''check'' command]] for details)
* some commands shouldn't be used inside the script:
** [[ {{NAMESPACE}}:Concept_Update_Server#Times_command |''times'']]: since the expert configuration is executed only once after a reboot of the device and when changes are made, it does not make sense to use the ''times'' command
** [[ {{NAMESPACE}}:Concept_Update_Server#Prot_command |''prot'']]|[[ {{NAMESPACE}}:Concept_Update_Server#Boot_command |''boot'']]: use an update job instead
** [[ {{NAMESPACE}}:Concept_Update_Server#Scfg_command |''scfg'']]: use a backup job instead
** [[Howto:PHP_based_Update_Server_V2#Using_vars_create|''vars create'']]: this cmd will always raise the ''reset needed condition'' and the aforementioned ''iresetn'' command would always execute therefore. As a result, the devices would enter a boot loop. Be sure to avoid this using an appropriate [[ {{NAMESPACE}}:Concept_Update_Server#Check_command |''check'' command ]] and update its ''<serial>'' properly whenever the expert configuration is changed

==== Certificates configuration ====
You can use this configuration to rollout certificates to the trust list of your devices. 

* Manual upload certificates.
* Configure up to five URLs which are polled every 24 hours. They must return files with PEM formatted public keys (one or more) which are then rolled out.
* Configure https://download.innovaphone.com/certificates/innovaphone.pem to always have the innovaphone public keys in your trust list (e.g. used for our push service).
* Configure https://download.innovaphone.com/certificates/ca.pem to always have the innovaphone Device Certification Authority certificates in your trust list.
* Configure https://download.innovaphone.com/certificates/ca-unverified.pem to always have the innovaphone Unverified Device Certification Authority certificates in your trust list.
** The Unverified CA is used for non hardware devices, e.g. IPVAs, which are not shipped with an official innovaphone Device Certification Authority certificate, as innovaphone has no control over the serial number here.

Using this configuration, the trust list can only be managed through ''Devices'' because it is cleared before each rollout.

=== Software rental ===
Regarding the Software Rental program and the Payment Method, please refer to:
* [[{{NAMESPACE}}:Concept_Software_Rental|Concept Software Rental]]

Software rental can be done for innovaphone Cloud installations or for software, which operates on the customer premisis. This could eventually be customer owned hardware or a privat virtual machine, managed by the customer.

==== Hardware licenses ====
Hardware licenses have to be bound on the specific device in my.innovaphone itself and currently can't be handled within the Devices App itself. So you also need to download the licenses from my.innovaphone and upload them on the device with the already known methods.

===== Hardware licenses with software rental =====
If your device has software rental licenses, you can bind hardware licenses within my.innovaphone in the software rental project itself.

===== Hardware licenses without software rental =====
If your device does not have software rental licenses, you should bind hardware licenses in a separate non rental project in my.innovaphone.

==== innovaphone Cloud ====
Inside the innovaphone Cloud, you just have to upload your activation keys with iSCs to add licenses to one or more gateways. 

==== Email expiry notifications ====
You will receive an email notification if the rental of a project expires. This notification will be sent '''seven''' weeks before the expiry and then once a week until the rental expires. 
You can configure one or more email recipients in the domain settings. 
If no email address is configured, the email address of the logged in user account is used.

==== History ====
You can download the history in the Devices App. You'll get a CSV file (semicolon separated). The date and number format depends on the selected language in the UI. 
There is also an API available for automated downloas, which is described [[ {{NAMESPACE}}:Concept_App_Service_Devices#API_to_download_rental_history|here ]].

====Own installation====
Inside your own installation, you have to register a new my.innovaphone account or you can use an existing account inside the Devices App. 
One domain inside Devices belongs to one project inside your my.innovaphone company, so you can handle multiple domains with one my.innovaphone account.

====Technical aspects====
A new rental expiration date is calculated on each license or balance change in the domain. 
So after each change new licenses with a new date are transfered to the gateways and also stored in the Devices App itself. 
If the rental expires, the gateway reboots and the licenses are not available anymore. 
The licenses are also transfered after each reconnect of a gateway to the Devices App. 
 
For license and balance changes, the Devices App must be online and have access to my.innovaphone.com!

====Usage====
You have to add (use the + symbol) a PBX and select all licenses you want to rent. 
Use the '''apply''' button to really bind these licenses. Without usage of the apply button, you can just see a precalculation of the iSCs/month and the rental end date, but nothing is really charged from your balance.

===Change of IP address/DNS name in PBX object===
If the IP address or DNS name inside the PBX object of the Devices App changes, all currently connected clients get a new Devices Registration URL and also all clients, which connect afterwards with the old host name.

== Appendix ==
=== Sample firmware.json ===
<code type="javascript">
{
"devices": [
{ "id": "IP0010", "versions": [ "13r1" ] },
{ "id": "IP0011", "versions": [ "13r1" ] },
{ "id": "IP101", "versions": [ "13r1" ] },
{ "id": "IP102", "versions": [ "13r1" ] },
{ "id": "IP1060", "versions": [ "13r1" ] },
{ "id": "IP110", "versions": [ "13r1" ] },
{ "id": "IP110A", "versions": [ "13r1" ] },
{ "id": "IP111", "versions": [ "13r1" ] },
{ "id": "IP112", "versions": [ "13r1" ] },
{ "id": "IP1130", "versions": [ "13r1" ] },
{ "id": "IP1260", "versions": [ "13r1" ] },
{ "id": "IP150", "versions": [ "13r1" ] },
{ "id": "IP2000", "versions": [ "13r1" ] },
{ "id": "IP200A", "versions": [ "13r1" ] },
{ "id": "IP22", "versions": [ "13r1" ] },
{ "id": "IP222", "versions": [ "13r1" ] },
{ "id": "IP230", "versions": [ "13r1" ] },
{ "id": "IP232", "versions": [ "13r1" ] },
{ "id": "IP24", "versions": [ "13r1" ] },
{ "id": "IP240", "versions": [ "13r1" ] },
{ "id": "IP241", "versions": [ "13r1" ] },
{ "id": "IP29", "versions": [ "13r1" ] },
{ "id": "IP3010", "versions": [ "13r1" ] },
{ "id": "IP3011", "versions": [ "13r1" ] },
{ "id": "IP302", "versions": [ "13r1" ] },
{ "id": "IP305", "versions": [ "13r1" ] },
{ "id": "IP311", "versions": [ "13r1" ] },
{ "id": "IP411", "versions": [ "13r1" ] },
{ "id": "IP6000", "versions": [ "13r1" ] },
{ "id": "IP6010", "versions": [ "13r1" ] },
{ "id": "IP800", "versions": [ "13r1" ] },
{ "id": "IP810", "versions": [ "13r1" ] },
{ "id": "IP811", "versions": [ "13r1" ] },
{ "id": "IPVA", "versions": [ "13r1" ] }
],
"versions": [
{ "id": "13r1", "build": "131705", "text": "13r1 dvl [131705]", "wiki": "" }
]
}
</code>

=== Sample apps.json ===
<code type="javascript">
{
"apps": [
{
"id": "apidemo",
"folder": "apidemo",
"binary": "apidemo",
"versions": [
{ "id": "13r1", "build": "131705", "label": "dvl" }
],
"manufacturer": "innovaphone",
"title": "Apidemo",
"description": "The Apidemo"
},
{
"id": "appstore",
"folder": "appstore",
"binary": "appstore",
"versions": [
{ "id": "13r1", "build": "131705", "label": "dvl" }
],
"manufacturer": "innovaphone",
"title": "AppStore",
"description": "AppStore"
}
]
}
</code>

=== Sample software.json ===
<code type="javascript">
{
"software": [
{
"id": "myappsandroid",
"folder": "myappsandroid",
"binary": "myapps.apk",
"versions": [
{ "id": "13r1", "build": "131705", "label": "dvl" }
],
"manufacturer": "innovaphone",
"title": "myApps Android",
"description": "myApps for Android"
},
{
"id": "myappswindows",
"folder": "myappswindows",
"binary": "myAppsSetup.msi",
"versions": [
{ "id": "13r1", "build": "131705", "label": "dvl" }
],
"manufacturer": "innovaphone",
"title": "myApps Windows",
"description": "myApps for Windows"
}
]
}
</code>

=== API to download rental history ===

You can download the history as a UTF-8 CSV file with simple '''HTTP GET''' requests with '''digest''' authentication. 
The CSV file uses the semicolon as delimiter. 
 
The URL to download the history is e.g.: 
'''<code>https://mydomain.com/mydomain.com/devices/csvapi?...</code>'''

You can find this path by editing the instance in the AP manager.
In the listed paths, you'll find something which ends with csvapi

In the innovaphone Cloud environment, the URL can be retrieved by taking a look at the Devices App object inside the cloud PBX and replacing the ending '''innovaphone-devices''' with '''csvapi''' inside the App URL, so it looks e.g. like this:

https://cloud-apps0.innovaphone.com/cloud.innovaphone.com/devices/csvapi

====CSV columns====
Most columns should be self explaining, but the column '''invoice reference''' refers to a value which you can configure manually in the domain settings in the Devices App!

====Digest authentication====
You can login with two different username/password combinations, while the domain is the digest username:

* If you use the domain and password of your Devices App instance inside the AP Manager, you have automatically access to all domains. 
* If you use the domain name of any domain as digest username and the configured domain password, you'll have access to this domain and all domains to which this domain has access to

====Query parameters====
The following query parameters can be used (don't forget to URL encode the parameter values, if neccessary!):
* all: if '''1''' or '''true''', the history is queried for all domains where the digest user has access to
* domain: required, if ''all'' is not set
* lang: the output language of the CSV file, which also controls date and number formats, e.g. '''en''', '''de''', ...
* tz: the timezone for dates, e.g. '''Europe/Berlin'''
* type: two types are available:
** '''history''': history which contains changes
** '''overview''': a monthly overview with the iSC costs at the first of the last months
* from: unix timestamp (UTC) in milliseconds, ignored for type=overview
* to: unix timestamp (UTC) in milliseconds, ignored for type=overview

====Example requests====
* <code>https://mydomain.com/mydomain.com/devices/csvapi?domain=mydomain.com&type=overview&lang=en&tz=Europe%2FBerlin</code>
* <code>https://mydomain.com/mydomain.com/devices/csvapi?domain=mydomain.com&type=history&lang=en&tz=Europe%2FBerlin&from=1601903431000&to=1601903385000</code>
* <code>https://mydomain.com/mydomain.com/devices/csvapi?all=1&type=overview&lang=en&tz=Europe%2FBerlin</code>

== Known issues ==

===SoftwarePhone===
The Devices App is not meant to be used with the windows SoftwarPhone standalone installation.

== Related Articles ==
* [[Howto:Software_Rental]]

Reference13r1:Phone/User/Preferences

2023-08-29T12:57:46Z

Maikschlz:

'''Language'''

The dialog language to be used for the telephone display.

'''Time format'''

The format to be used for date and time display in the bottom line of the telephone display.

'''Call waiting'''

Defines if incoming calls should be accepted when the phone is busy with another call and how such calls should be indicated to the user.
An accepted call is put in alerting state and the calling party receives a call-waiting indication.
* enabled - default tone: The country-specific call waiting tone sequence is played.
* enabled - beep once: A short alerting tone is played once.
* enabled - silent: No alerting tone is played, i.e. there is only the visible indication for the waiting call.
* disabled: The call is rejected.

'''Hide own number'''

Hide the calling party number in outbound calls (CLIR - Calling Line Identification Restriction).

'''Enable call intrusion'''

Permit a partner to take part in an already active call. Dependent on the partners configuration the partner listens only to the communication (silent monitoring mode) or takes part as in a conference call (conference mode).
In addition to work, the function must be activated at the phone as described in [[Reference13r1:Phone/User/Preferences]].

'''Visual Ringing Indication'''

If set, the phone lamp will blink during ringing.

'''Disable Phonenumber Look-up'''

Do not perform LDAP phonenumber-to-name lookup (name resolution) in the phone. If this flag is set, incoming calls are expected to already carry the name identification. In a V13 (and up) installation, this type of name resolution is done by the PBX as controlled by ''Reverse Lookup URL'' in [[{{NAMESPACE}}:PBX/Config/General#Common]].

'''Announcement calls'''

Announcement calls are set up with the ''Dial'' Function key with the ''Announcement'' checkmark set.

Incoming announcement calls are usually connected automatically. If the phone is idle an incoming announcement call is connected in handsfree mode. If the phone is busy with another call this call is put on hold and the announcement call is connected in the currently active mode (handsfree/handset/headset).
In either case the microphone is disabled. It is enabled aqain when the microphone key is pressed or when the mode is changed for example from handset to handsfree. Incoming announcement calls are acoustically signaled by a short standard tone or if the phone is idle by the ring melody configured under ''Ring Tones''.

*Incoming
** Reject: Reject any announcement call.
** Reject if Busy: Reject an announcement call if the phone is busy with another call.
** Micro on: Switch the microphone on when the call is connected. This permits a response without pressing any key before.
** Audible Signal Off: Connect the call silently without any acoustical indication.
** Treat any Call as Announcement: All incoming calls will be treated as announcement calls, i.e. incoming calls are automatically connected.

*Outgoing:
**Allow: Allow to set up outgoing announcement calls. If not checked the ''Announcement'' checkmark of a ''Dial'' Function key has no effect.

'''Ring tones'''

For acoustical identification of the different types of incoming calls (internal, external...) specific ring tones and volumes can be defined. The ring tones are listed under [[Reference9:Phone/Ring-Tones]], may be played on the telephone, and further ring tones can be loaded.

The ring tones for ''Announcement Calls'' and ''Multicast Announcements'' must be additionally enabled under [[Reference9:Phone/Preferences]], with option ''Play Configured Ring Melody before Automatically Connecting an Announcement Call''.

'''Ring filter'''

Up to five calling parties (for example VIP numbers) or groups may get own ring tones assigned here.
* Number: Calling party/group number.
* Name: Calling party/group name.
* Type: Type of calls to be checked for a matching identification.
** Any: Check calling party number/name of any call.
** External: Check calling party number/name of external calls only.
** Group: Check number/name (diverting number/name) of diverted calls. Example: Waiting Queue/Call Broadcast Name/Number.
* Volume: The volume to be used when playing the ring melody.
* Melody: The ring melody to be played.

'''Do not disturb'''

This function allows you to respond in a particular way to incoming calls. The incoming calls are choosen under

*Apply to
**internal calls
**external calls
**any call

For the choosen type of incoming calls, the possible responses can be defined as
*Action
**do not ring: Calls are silently accepted (put to alerting state) but not signaled acoustically.
**reject call (busy): Calls are immediately rejected with cause ''User Busy''. The caller receives a busy signal.
**ignore call (no response): No response is sent to the caller and thus after a timeout the caller will get a disconnect with cause "No User Responding".
**out of office (ignore call and send absence message): Instead of a response to the call a predefined absence message is sen to the caller.

'''Favourite diversions'''

Call forward can be set either using the [[Reference7:Configuration/Registration/Function-Keys/Call-Forwarding | Call Forwarding ]] function key or the ''Menu / User Setup / Call Diversion'' menu directly on the phone. For the latter, default forward targets can be defined here.

'''Favourite List Configuration'''

Define display order of predefines favourite lists.
* Phone: displayed favourite list on phone display in favourite app
* Extension Module 1: displayed favourite list on 1st extension module if present
* Extension Module 2: displayed favourite list on 2nd extension module if present

Drop down shows available favourite lists.

'''Call Media'''
* Autostart Video: force phone to start video protocol negotiation upon call for use in UC-client

Howto:Network VoIP Readiness Test

2023-03-20T11:11:05Z

Maikschlz: /* Iperf */

==Applies To==
This information applies to

*all innovaphone VoIP Gateways and Phones



==More Information==
===Problem Details===
The VoIP as application on a network requires a stable connecton able to transport big number of UDP packets between two VoIP endpoints in both directions with minimal delay, jitter and packet loss.

Especially on WAN connections, a lack of available bandwidth, jitter or packet loss can affect voice quality on VoIP calls.

To test the connection between two VoIP endpoints with WAN connection between, it is not enough to send a few small ICMP ping packets. Furthermore a bidirectional stream of UDP packets with defined payload and interval must be sent over longer period of time.

===Iperf===
For this purpose can be used an open source tool [http://iperf.fr/ Iperf].

To test the connection between to sites put a PC with Iperf on each. Iperf works in Server-Client mode, so on one host the Iperf must be started in the server mode, on the second PC in the client mode.

Download Iperf binaries for your operating system an make sure you can start Iperf from the command line:

C:\temp>iperf -v
iperf version 2.0.5 (08 Jul 2010) pthreads

Now we will test a connection between two sites by simulating one G711 call. To test more calls add the parameter <code>--parallel 4</code> to server and client command lines.

On the server host execute following command:

iperf --server --udp --len 300 --tos 184 -fk --interval 5

On the client host use following command:

iperf -c SERVER_IP_OR_HOSTNAME --udp --len 300 --bandwidth 67000 --dualtest --tos 184 -fk --interval 5 --time 60 --listenport 5002

With this prameters iperf will generate a bi-directional stream of UDP packets for 60 seconds and consume bandwidth of 67 kBit/s (RTP stream with G711 30ms frame size payload, for other codecs bandwidth usage please refer to [http://www.bandcalc.com/ www.bandcalc.com])

The resulting statistics should look like this on client Side:
[ ID] Interval Transfer Bandwidth
[ 4] 0.0- 5.0 sec 41.3 KBytes 67.7 Kbits/sec
[ 3] 0.0- 5.0 sec 41.0 KBytes 67.2 Kbits/sec 0.153 ms 0/ 140 (0%)
[ 3] 5.0-10.0 sec 40.7 KBytes 66.7 Kbits/sec 0.201 ms 0/ 139 (0%)
[ 4] 5.0-10.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 10.0-15.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 10.0-15.0 sec 41.0 KBytes 67.2 Kbits/sec 0.122 ms 0/ 140 (0%)
[ 4] 15.0-20.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 15.0-20.0 sec 41.0 KBytes 67.2 Kbits/sec 0.224 ms 0/ 140 (0%)
[ 4] 20.0-25.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 20.0-25.0 sec 40.7 KBytes 66.7 Kbits/sec 0.353 ms 0/ 139 (0%)
[ 4] 25.0-30.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 25.0-30.0 sec 41.0 KBytes 67.2 Kbits/sec 0.504 ms 0/ 140 (0%)
[ 4] 30.0-35.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 30.0-35.0 sec 41.0 KBytes 67.2 Kbits/sec 0.349 ms 0/ 140 (0%)
[ 4] 35.0-40.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 35.0-40.0 sec 40.7 KBytes 66.7 Kbits/sec 0.208 ms 0/ 139 (0%)
[ 4] 40.0-45.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 40.0-45.0 sec 41.0 KBytes 67.2 Kbits/sec 0.213 ms 0/ 140 (0%)
[ 4] 45.0-50.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 45.0-50.0 sec 40.7 KBytes 66.7 Kbits/sec 0.553 ms 0/ 139 (0%)
[ 4] 50.0-55.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 50.0-55.0 sec 41.0 KBytes 67.2 Kbits/sec 0.421 ms 0/ 140 (0%)
[ 3] 55.0-60.0 sec 40.7 KBytes 66.7 Kbits/sec 0.254 ms 0/ 139 (0%)
[ 3] 0.0-60.0 sec 476 KBytes 65.0 Kbits/sec 0.250 ms 0/ 1626 (0%)

On Server Side:
[ ID] Interval Transfer Bandwidth Jitter Lost/Total Datagrams
[ 3] 0.0- 5.0 sec 41.6 KBytes 68.2 Kbits/sec 0.326 ms 0/ 142 (0%)
[ 4] 0.0- 5.0 sec 41.3 KBytes 67.7 Kbits/sec
[ 3] 5.0-10.0 sec 41.0 KBytes 67.2 Kbits/sec 1.689 ms 0/ 140 (0%)
[ 4] 5.0-10.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 10.0-15.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 10.0-15.0 sec 41.0 KBytes 67.2 Kbits/sec 0.511 ms 0/ 140 (0%)
[ 3] 15.0-20.0 sec 40.7 KBytes 66.7 Kbits/sec 3.041 ms 0/ 139 (0%)
[ 4] 15.0-20.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 20.0-25.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 20.0-25.0 sec 41.0 KBytes 67.2 Kbits/sec 0.282 ms 0/ 140 (0%)
[ 3] 25.0-30.0 sec 40.7 KBytes 66.7 Kbits/sec 7.918 ms 0/ 139 (0%)
[ 4] 25.0-30.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 30.0-35.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 30.0-35.0 sec 41.0 KBytes 67.2 Kbits/sec 0.760 ms 0/ 140 (0%)
[ 4] 35.0-40.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 35.0-40.0 sec 41.0 KBytes 67.2 Kbits/sec 1.108 ms 0/ 140 (0%)
[ 3] 40.0-45.0 sec 40.7 KBytes 66.7 Kbits/sec 1.120 ms 0/ 139 (0%)
[ 4] 40.0-45.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 45.0-50.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 45.0-50.0 sec 41.0 KBytes 67.2 Kbits/sec 7.484 ms 0/ 140 (0%)
[ 3] 50.0-55.0 sec 40.7 KBytes 66.7 Kbits/sec 0.519 ms 0/ 139 (0%)
[ 4] 50.0-55.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 55.0-60.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 0.0-55.0 sec 476 KBytes 66.7 Kbits/sec 0.519 ms 0/ 1626 (0%)

For good voice quality there should be no packet loss and jitter should not higher than few milliseconds.

=== Releated Articles ===
* [[Howto:Calculate_Values_for_Type_of_Service_(ToS)_from_DiffServ_or_DSCP_Values]]

[[Category:Howto|{{PAGENAME}}]]

Howto:Network VoIP Readiness Test

2023-03-20T11:10:43Z

Maikschlz: /* Iperf */

==Applies To==
This information applies to

*all innovaphone VoIP Gateways and Phones



==More Information==
===Problem Details===
The VoIP as application on a network requires a stable connecton able to transport big number of UDP packets between two VoIP endpoints in both directions with minimal delay, jitter and packet loss.

Especially on WAN connections, a lack of available bandwidth, jitter or packet loss can affect voice quality on VoIP calls.

To test the connection between two VoIP endpoints with WAN connection between, it is not enough to send a few small ICMP ping packets. Furthermore a bidirectional stream of UDP packets with defined payload and interval must be sent over longer period of time.

===Iperf===
For this purpose can be used an open source tool [http://iperf.fr/ Iperf].

To test the connection between to sites put a PC with Iperf on each. Iperf works in Server-Client mode, so on one host the Iperf must be started in the server mode, on the second PC in the client mode.

Download Iperf binaries for your operating system an make sure you can start Iperf from the command line:

C:\temp>iperf -v
iperf version 2.0.5 (08 Jul 2010) pthreads

Now we will test a connection between two sites by simulating one G711 call. To test more calls add the parameter <code>--parallel 4</code> to server and client command lines.

On the server host execute following command:

iperf --server --udp --len 300 --tos 184 -fk --interval 5

On the client host use following command:

iperf -c SERVER_IP_OR_HOSTNAME --udp --len 300 --bandwidth 67000 --dualtest --tos 184 -fk --interval 5 --time 60 --listenport 5002

With this prameters iperf will generate a bi-directional stream of UDP packets for 60 seconds and consume bandwidth of 67 kBit/s (RTP stream with G711 30ms frame size payload, for other codecs bandwidth usage please refer to [http://www.bandcalc.com/ www.bandcalc.com])

The resulting statistics should look like this on client Side:

[ ID] Interval Transfer Bandwidth
[ 4] 0.0- 5.0 sec 41.3 KBytes 67.7 Kbits/sec
[ 3] 0.0- 5.0 sec 41.0 KBytes 67.2 Kbits/sec 0.153 ms 0/ 140 (0%)
[ 3] 5.0-10.0 sec 40.7 KBytes 66.7 Kbits/sec 0.201 ms 0/ 139 (0%)
[ 4] 5.0-10.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 10.0-15.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 10.0-15.0 sec 41.0 KBytes 67.2 Kbits/sec 0.122 ms 0/ 140 (0%)
[ 4] 15.0-20.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 15.0-20.0 sec 41.0 KBytes 67.2 Kbits/sec 0.224 ms 0/ 140 (0%)
[ 4] 20.0-25.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 20.0-25.0 sec 40.7 KBytes 66.7 Kbits/sec 0.353 ms 0/ 139 (0%)
[ 4] 25.0-30.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 25.0-30.0 sec 41.0 KBytes 67.2 Kbits/sec 0.504 ms 0/ 140 (0%)
[ 4] 30.0-35.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 30.0-35.0 sec 41.0 KBytes 67.2 Kbits/sec 0.349 ms 0/ 140 (0%)
[ 4] 35.0-40.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 35.0-40.0 sec 40.7 KBytes 66.7 Kbits/sec 0.208 ms 0/ 139 (0%)
[ 4] 40.0-45.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 40.0-45.0 sec 41.0 KBytes 67.2 Kbits/sec 0.213 ms 0/ 140 (0%)
[ 4] 45.0-50.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 45.0-50.0 sec 40.7 KBytes 66.7 Kbits/sec 0.553 ms 0/ 139 (0%)
[ 4] 50.0-55.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 50.0-55.0 sec 41.0 KBytes 67.2 Kbits/sec 0.421 ms 0/ 140 (0%)
[ 3] 55.0-60.0 sec 40.7 KBytes 66.7 Kbits/sec 0.254 ms 0/ 139 (0%)
[ 3] 0.0-60.0 sec 476 KBytes 65.0 Kbits/sec 0.250 ms 0/ 1626 (0%)

On Server Side:
[ ID] Interval Transfer Bandwidth Jitter Lost/Total Datagrams
[ 3] 0.0- 5.0 sec 41.6 KBytes 68.2 Kbits/sec 0.326 ms 0/ 142 (0%)
[ 4] 0.0- 5.0 sec 41.3 KBytes 67.7 Kbits/sec
[ 3] 5.0-10.0 sec 41.0 KBytes 67.2 Kbits/sec 1.689 ms 0/ 140 (0%)
[ 4] 5.0-10.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 10.0-15.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 10.0-15.0 sec 41.0 KBytes 67.2 Kbits/sec 0.511 ms 0/ 140 (0%)
[ 3] 15.0-20.0 sec 40.7 KBytes 66.7 Kbits/sec 3.041 ms 0/ 139 (0%)
[ 4] 15.0-20.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 20.0-25.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 20.0-25.0 sec 41.0 KBytes 67.2 Kbits/sec 0.282 ms 0/ 140 (0%)
[ 3] 25.0-30.0 sec 40.7 KBytes 66.7 Kbits/sec 7.918 ms 0/ 139 (0%)
[ 4] 25.0-30.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 30.0-35.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 30.0-35.0 sec 41.0 KBytes 67.2 Kbits/sec 0.760 ms 0/ 140 (0%)
[ 4] 35.0-40.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 35.0-40.0 sec 41.0 KBytes 67.2 Kbits/sec 1.108 ms 0/ 140 (0%)
[ 3] 40.0-45.0 sec 40.7 KBytes 66.7 Kbits/sec 1.120 ms 0/ 139 (0%)
[ 4] 40.0-45.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 45.0-50.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 45.0-50.0 sec 41.0 KBytes 67.2 Kbits/sec 7.484 ms 0/ 140 (0%)
[ 3] 50.0-55.0 sec 40.7 KBytes 66.7 Kbits/sec 0.519 ms 0/ 139 (0%)
[ 4] 50.0-55.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 55.0-60.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 0.0-55.0 sec 476 KBytes 66.7 Kbits/sec 0.519 ms 0/ 1626 (0%)

For good voice quality there should be no packet loss and jitter should not higher than few milliseconds.

=== Releated Articles ===
* [[Howto:Calculate_Values_for_Type_of_Service_(ToS)_from_DiffServ_or_DSCP_Values]]

[[Category:Howto|{{PAGENAME}}]]

Howto:Network VoIP Readiness Test

2023-03-20T11:09:23Z

Maikschlz: /* Iperf */

==Applies To==
This information applies to

*all innovaphone VoIP Gateways and Phones



==More Information==
===Problem Details===
The VoIP as application on a network requires a stable connecton able to transport big number of UDP packets between two VoIP endpoints in both directions with minimal delay, jitter and packet loss.

Especially on WAN connections, a lack of available bandwidth, jitter or packet loss can affect voice quality on VoIP calls.

To test the connection between two VoIP endpoints with WAN connection between, it is not enough to send a few small ICMP ping packets. Furthermore a bidirectional stream of UDP packets with defined payload and interval must be sent over longer period of time.

===Iperf===
For this purpose can be used an open source tool [http://iperf.fr/ Iperf].

To test the connection between to sites put a PC with Iperf on each. Iperf works in Server-Client mode, so on one host the Iperf must be started in the server mode, on the second PC in the client mode.

Download Iperf binaries for your operating system an make sure you can start Iperf from the command line:

C:\temp>iperf -v
iperf version 2.0.5 (08 Jul 2010) pthreads

Now we will test a connection between two sites by simulating one G711 call. To test more calls add the parameter <code>--parallel 4</code> to server and client command lines.

On the server host execute following command:

iperf --server --udp --len 300 --tos 184 -fk --interval 5

On the client host use following command:

iperf -c SERVER_IP_OR_HOSTNAME --udp --len 300 --bandwidth 67000 --dualtest --tos 184 -fk --interval 5 --time 60 --listenport 5002

With this prameters iperf will generate a bi-directional stream of UDP packets for 60 seconds and consume bandwidth of 67 kBit/s (RTP stream with G711 30ms frame size payload, for other codecs bandwidth usage please refer to [http://www.bandcalc.com/ www.bandcalc.com])

The resulting statistics should look like this on client Side:

[ ID] Interval Transfer Bandwidth
[ 4] 0.0- 5.0 sec 41.3 KBytes 67.7 Kbits/sec
[ 3] 0.0- 5.0 sec 41.0 KBytes 67.2 Kbits/sec 0.153 ms 0/ 140 (0%)
[ 3] 5.0-10.0 sec 40.7 KBytes 66.7 Kbits/sec 0.201 ms 0/ 139 (0%)
[ 4] 5.0-10.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 10.0-15.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 10.0-15.0 sec 41.0 KBytes 67.2 Kbits/sec 0.122 ms 0/ 140 (0%)
[ 4] 15.0-20.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 15.0-20.0 sec 41.0 KBytes 67.2 Kbits/sec 0.224 ms 0/ 140 (0%)
[ 4] 20.0-25.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 20.0-25.0 sec 40.7 KBytes 66.7 Kbits/sec 0.353 ms 0/ 139 (0%)
[ 4] 25.0-30.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 25.0-30.0 sec 41.0 KBytes 67.2 Kbits/sec 0.504 ms 0/ 140 (0%)
[ 4] 30.0-35.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 30.0-35.0 sec 41.0 KBytes 67.2 Kbits/sec 0.349 ms 0/ 140 (0%)
[ 4] 35.0-40.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 35.0-40.0 sec 40.7 KBytes 66.7 Kbits/sec 0.208 ms 0/ 139 (0%)
[ 4] 40.0-45.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 40.0-45.0 sec 41.0 KBytes 67.2 Kbits/sec 0.213 ms 0/ 140 (0%)
[ 4] 45.0-50.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 45.0-50.0 sec 40.7 KBytes 66.7 Kbits/sec 0.553 ms 0/ 139 (0%)
[ 4] 50.0-55.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 50.0-55.0 sec 41.0 KBytes 67.2 Kbits/sec 0.421 ms 0/ 140 (0%)
[ 3] 55.0-60.0 sec 40.7 KBytes 66.7 Kbits/sec 0.254 ms 0/ 139 (0%)
[ 3] 0.0-60.0 sec 476 KBytes 65.0 Kbits/sec 0.250 ms 0/ 1626 (0%)

On Server Side:
[ ID] Interval Transfer Bandwidth Jitter Lost/Total Datagrams
[ 3] 0.0- 5.0 sec 41.6 KBytes 68.2 Kbits/sec 0.326 ms 0/ 142 (0%)
[ 4] 0.0- 5.0 sec 41.3 KBytes 67.7 Kbits/sec
[ 3] 5.0-10.0 sec 41.0 KBytes 67.2 Kbits/sec 1.689 ms 0/ 140 (0%)
[ 4] 5.0-10.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 10.0-15.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 10.0-15.0 sec 41.0 KBytes 67.2 Kbits/sec 0.511 ms 0/ 140 (0%)
[ 3] 15.0-20.0 sec 40.7 KBytes 66.7 Kbits/sec 3.041 ms 0/ 139 (0%)
[ 4] 15.0-20.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 20.0-25.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 20.0-25.0 sec 41.0 KBytes 67.2 Kbits/sec 0.282 ms 0/ 140 (0%)
[ 3] 25.0-30.0 sec 40.7 KBytes 66.7 Kbits/sec 7.918 ms 0/ 139 (0%)
[ 4] 25.0-30.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 30.0-35.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 30.0-35.0 sec 41.0 KBytes 67.2 Kbits/sec 0.760 ms 0/ 140 (0%)
[ 4] 35.0-40.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 3] 35.0-40.0 sec 41.0 KBytes 67.2 Kbits/sec 1.108 ms 0/ 140 (0%)
[ 3] 40.0-45.0 sec 40.7 KBytes 66.7 Kbits/sec 1.120 ms 0/ 139 (0%)
[ 4] 40.0-45.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 45.0-50.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 45.0-50.0 sec 41.0 KBytes 67.2 Kbits/sec 7.484 ms 0/ 140 (0%)
[ 3] 50.0-55.0 sec 40.7 KBytes 66.7 Kbits/sec 0.519 ms 0/ 139 (0%)
[ 4] 50.0-55.0 sec 41.0 KBytes 67.2 Kbits/sec
[ 4] 55.0-60.0 sec 40.7 KBytes 66.7 Kbits/sec
[ 3] 0.0-55.0 sec 476 KBytes 66.7 Kbits/sec 0.519 ms 0/ 1626 (0%)

For good voice quality there should be no packet loss and jitter should not higher than few milliseconds.

=== Releated Articles ===
* [[Howto:Calculate_Values_for_Type_of_Service_(ToS)_from_DiffServ_or_DSCP_Values]]

[[Category:Howto|{{PAGENAME}}]]

Howto:DE - Plusnet - IPFonie Extended Connect TLS SRTP SIP-Provider (2016)

2021-09-21T10:06:17Z

Maikschlz: /* Configuration */

== Summary ==
{{Template:SIP_TEST_STATUS_complete|update=July 15th, 2020|url=https://www.plusnet.de/de/corporate-solutions/telefonie/sip-anschluesse/ipfonie-extended-connect/|productname=IPfonie_Extended_Connect_TLS_SRTP|providername=Plusnet}}
=== Remarks ===
* Registration: The provider supports also unencryted communication with SIP-TCP/RTP. Tests were done only with encryption(SIP-TLS/SRTP).
* FAX T38: Encrypted Trunks do not support T.38, because fallback to unencrypted media is disabled for security reasons. T.38 protocol itself does not have an encrypted variant currently specified. Use G.711 pass-through for FAX support.
* Redundancy: The provider has an own failover detection using OPTIONS-packets. If more than one SIP-Interface are registered at the same account and one interface stops answering the OPTIONS-packet of the provider, calls are not sent to this interface unless OPTIONS-packets are again answered.
** The OPTIONS-packets intervall is 60 seconds, which is also the max. downtime of not forwarded calls to a working SIP-interface.

<internal>Provider SBC: Huawei SoftX3000 V300R010</internal>

=== {{SIP_TEST_ISSUES_NO_MR_TITLE}} ===
{{SIP_TEST_ISSUES_NO_MR_INTRO}}
; EARLY MEDIA INBOUND : {{SIP_TEST_FACT_EARLY MEDIA INBOUND}}
; FAX T38 ONNET : {{SIP_TEST_FACT_FAX T38 ONNET}}
; FAX T38 : {{SIP_TEST_FACT_FAX T38}}
; REDIR 302 : {{SIP_TEST_FACT_REDIR 302}}
; SIP INFO : {{SIP_TEST_FACT_SIP INFO}}

{{SIP_TEST_FACTS_LIST}} [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_180_RINGING_FAILS|180_RINGING]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_BASIC_CALL_FAILS|BASIC_CALL]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_CLIR_FAILS|CLIR]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_CLNS_ONNET_FAILS|CLNS_ONNET]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_CLNS_FAILS|CLNS]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_CONN_NR_DIFF_FAILS|CONN_NR_DIFF]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_CONN_NR_INCOMING_FAILS|CONN_NR_INCOMING]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_CONN_NR_FAILS|CONN_NR]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_DTMF_FAILS|DTMF]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_EARLY_MEDIA_INBOUND_FAILS|EARLY_MEDIA_INBOUND]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_FAX_AUDIO_FAILS|FAX_AUDIO]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_FAX_T38_ONNET_FAILS|FAX_T38_ONNET]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_FAX_T38_FAILS|FAX_T38]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_FAX_T38ANDAUDIO_FAILS|FAX_T38ANDAUDIO]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G711A_ONNET_FAILS|G711A_ONNET]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G711A_FAILS|G711A]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G711U_ONNET_FAILS|G711U_ONNET]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G711U_FAILS|G711U]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G722_ONNET_FAILS|G722_ONNET]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G722_FAILS|G722]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G729_ONNET_FAILS|G729_ONNET]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G729_FAILS|G729]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_HOLD_RETRIEVE_FAILS|HOLD_RETRIEVE]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_IP_FRAGMENTATION_FAILS|IP_FRAGMENTATION]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_LARGE_SIP_MESSAGES_FAILS|LARGE_SIP_MESSAGES]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_MOBILITY_FAILS|MOBILITY]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_OPUS_NB_FAILS|OPUS_NB]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_OPUS_WB_FAILS|OPUS_WB]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_RALERT_DISC_FAILS|RALERT_DISC]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_REDIR_302_FAILS|REDIR_302]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_REDIR_DIVHDR_FAILS|REDIR_DIVHDR]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_REDIR_HISTHDR_FAILS|REDIR_HISTHDR]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_REVERSE_MEDIA_FAILS|REVERSE_MEDIA]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SDP_ICE_FAILS|SDP_ICE]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SDP_RTCP_MUX_FAILS|SDP_RTCP_MUX]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SDP_VIDEO_FAILS|SDP_VIDEO]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SIP_INFO_FAILS|SIP_INFO]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SRTP_INCOMING_FAILS|SRTP_INCOMING]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SRTP_INTERNAL_FAILS|SRTP_INTERNAL]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SRTP_OUTGOING_FAILS|SRTP_OUTGOING]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SUBSCRIBER_NR_FAILS|SUBSCRIBER_NR]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_XFER_BLIND_FAILS|XFER_BLIND]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_XFER_CONS_ALERT_FAILS|XFER_CONS_ALERT]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_XFER_CONS_EXT_FAILS|XFER_CONS_EXT]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_XFER_CONS_FAILS|XFER_CONS]]

=== {{SIP_TEST_ISSUES_MR_TITLE}} ===
{{SIP_TEST_ISSUES_ALTERNATE_INTRO}}
{{SIP_TEST_ISSUES_MR_INTRO}}
{{SIP_TEST_ISSUES_NO_ALTERNATE_ISSUES}}

== Test Results ==
{{SIP_TEST_TESTRESULT_BOTH_INTRO}}
=== {{SIP_TEST_RESULTS_NO_MR_TITLE}} ===
; Registration : {{SIP_Profile_Test_Registration_TLS_NO_UDP_NO_TCP}}

; NAT Traversal : {{Template:SIP_Profile_Test_NAT_a_c}}

; DTMF (RFC2833) : {{Template:SIP_Profile_Test_DTMF_RFC2833_yes}}

; Session Timer : {{Template:SIP_Profile_Test_EXPIRES_yes}}

; Redundancy : {{Template:SIP_Profile_Test_REDUNDANCY_yes_FAILOVER_no|timeout=2 minutes}}

; Correct signalling of Ringing-state : {{Template:SIP_Profile_Test_RINGING_yes}}

; CLIR : {{Template:SIP_Profile_Test_CLIR_yes}}

; Clip No Screening (CLNS) : {{Template:SIP_Profile_Test_CLNS_yes}}

; COLP : {{Template:SIP_Profile_Test_COLP_out_yes_in_yes}} {{Template:SIP_Profile_Test_COLP_diff_no}}

; Early-Media : {{Template:SIP_Profile_Test_EARLY_MEDIA_INBOUND_no}}

; Fax : {{Template:SIP_Profile_Test_AUDIOFAX_PSTN_yes}}
: {{Template:SIP_Profile_Test_T38_PSTN_no_onnet_no_fallback_yes}}

; Codecs : supported to/from PSTN: G711A
: supported onnet (VoIP to VoIP): G711A, G711U, G722 and G729

; IP-Fragmentation : {{Template:SIP_Profile_Test_FRAGMENTATION_yes}}

; Large SIP messages : {{Template:SIP_Profile_Test_LARGE_MESSAGES_yes}}

; Reverse Media Negotiation : {{Template:SIP_Profile_Test_REV_MEDIA_NEG_yes}}

; Mobility Calls : {{Template:SIP_Profile_Test_MobilityCall_no_without_MediaRelay}}

; SRTP : {{Template:SIP_Profile_Test_SRTP_yes}}

; Dialing of Subscriber Numbers : {{Template:SIP_Profile_Test_SUBSCRIBER_NR_no}}

; Call Transfer : {{Template:SIP_Profile_Test_CALL_TRANSFER_ok}}

=== {{SIP_TEST_RESULTS_MR_TITLE}} ===
; Registration : {{SIP_Profile_Test_Registration_TLS_NO_UDP_NO_TCP}}

; NAT Traversal : {{Template:SIP_Profile_Test_NAT_a_c}}

; DTMF (RFC2833) : {{Template:SIP_Profile_Test_DTMF_RFC2833_yes}}

; Session Timer : {{Template:SIP_Profile_Test_EXPIRES_yes}}

; Redundancy : {{Template:SIP_Profile_Test_REDUNDANCY_yes_FAILOVER_no|timeout=2 minutes}}

; Correct signalling of Ringing-state : {{Template:SIP_Profile_Test_RINGING_yes}}

; CLIR : {{Template:SIP_Profile_Test_CLIR_yes}}

; Clip No Screening (CLNS) : {{Template:SIP_Profile_Test_CLNS_yes}}

; COLP : {{Template:SIP_Profile_Test_COLP_out_yes_in_yes}} {{Template:SIP_Profile_Test_COLP_diff_no}}

; Early-Media : {{Template:SIP_Profile_Test_EARLY_MEDIA_INBOUND_no}}

; Fax : {{Template:SIP_Profile_Test_AUDIOFAX_PSTN_yes}}
: {{Template:SIP_Profile_Test_T38_PSTN_no_onnet_no_fallback_yes}}

; Codecs : supported to/from PSTN: G711A
: supported onnet (VoIP to VoIP): G711A, G711U, G722 and G729

; IP-Fragmentation : {{Template:SIP_Profile_Test_FRAGMENTATION_yes}}

; Large SIP messages : {{Template:SIP_Profile_Test_LARGE_MESSAGES_yes}}

; Reverse Media Negotiation : {{Template:SIP_Profile_Test_REV_MEDIA_NEG_yes}}

; Mobility Calls : {{Template:SIP_Profile_Test_MobilityCall_no_with_MediaRelay}}

; SRTP : {{Template:SIP_Profile_Test_SRTP_yes}}

; Dialing of Subscriber Numbers : {{Template:SIP_Profile_Test_SUBSCRIBER_NR_no}}

; Call Transfer : {{Template:SIP_Profile_Test_CALL_TRANSFER_ok}}

==Configuration==
Use profile ''DE-Plusnet-IPfonie_Extended_Connect_TLS_SRTP'' in ''Gateway/Interfaces/SIP'' to configure this SIP provider.

Please note the following configuration hints:
* <nowiki>If you intend to use SIPS (SIP/TLS) registration, you need to add the ' DigiCert Global root CA' (valid until 10 Nov 2031) certificate to the trust list of your SBC</nowiki>
* <nowiki>Dialling of subscriber numbers not possible, 'Dialing Location' must be configured without 'Area Code'</nowiki>

: {{SIP_TEST_V13_HINT}}

== Disclaimer ==
{{SIP_TEST_PREFACE}}

[[Category:Compat|{{PAGENAME}}]]
[[Category:3rdParty SIP Provider|{{PAGENAME}}]]