Skip to content

Telephony#

General telephony settings are combined within this telephony section.

To configure a basic connection to your telephony service or pbx you need to configure an Identity

Defaults#

Commented File-structure#

telephony.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- settings for local telephony features. -->
<telephony version="1.26.11">
  <callWaiting>
    <!-- enables the function callWaiting
         type: boolean -->
    <active>false</active>
    <!-- enables the signalisation of a waiting call
         type: boolean -->
    <tone>true</tone>
  </callWaiting>
  <doNotDisturb>
    <!-- enables the function doNotDisturb
         type: boolean -->
    <active>false</active>
  </doNotDisturb>
  <callForwarding>
    <unconditional>
      <!-- enables call forwarding
           type: boolean -->
      <active>false</active>
      <!-- type: string -->
      <target></target>
      <!-- the time [s] after which the call must be forwarded
           type: integer -->
      <timeout>20</timeout>
    </unconditional>
    <busy>
      <!-- enables call forwarding
           type: boolean -->
      <active>false</active>
      <!-- type: string -->
      <target></target>
      <!-- the time [s] after which the call must be forwarded
           type: integer -->
      <timeout>20</timeout>
    </busy>
    <noResponse>
      <!-- enables call forwarding
           type: boolean -->
      <active>false</active>
      <!-- type: string -->
      <target></target>
      <!-- the time [s] after which the call must be forwarded
           type: integer -->
      <timeout>20</timeout>
    </noResponse>
  </callForwarding>
  <clir>
    <!-- Tells the PBX to hide the callers identity in outgoing calls.
         type: boolean -->
    <active>false</active>
  </clir>
  <reverseNumberLookup>
    <!-- When enabled looks for name of call-partner in adressbooks (local, ldap, ..).
         type: boolean -->
    <active>true</active>
  </reverseNumberLookup>
  <!-- type: enum
       accepted values:
         speaker
         headset -->
  <defaultAudioDevice></defaultAudioDevice>
  <activeLine>
    <!-- type: string -->
    <id></id>
    <!-- type: string -->
    <component></component>
  </activeLine>
  <!-- Time delay to start the call when there is no activity. Measured in milliseconds. -1 = never
       type: integer -->
  <callStartTimeout>-1</callStartTimeout>
  <autoAccept>
    <!-- allow calls to automatically connect when they want to (in SIP-invite -> Alert-Info-header with info=alert-autoanswer)
         type: boolean -->
    <immediatelyWhenRequested>false</immediatelyWhenRequested>
    <!-- Time delay to accept an incoming call automatically. Measured in milliseconds. -1 = never
         type: integer
         minimum: -1
         maximum: 60000 -->
    <afterTimeout>-1</afterTimeout>
    <!-- sound a short signal when a call gets auto-connected
         type: boolean -->
    <withAlarmBeep>true</withAlarmBeep>
    <!-- place ongoing calls on hold in order to connect auto-answer-call. With false just lets them knock.
         type: boolean -->
    <interruptWhenBusy>false</interruptWhenBusy>
  </autoAccept>
  <callCompletion>
    <!-- enables the function callCompletion
         type: boolean -->
    <active>true</active>
    <!-- time to wait for 'not responding' in seconds
         type: integer
         minimum: -1
         maximum: 60 -->
    <timeout>-1</timeout>
  </callCompletion>
  <!-- type: list -->
  <callBindings>
    <!-- Define custom softkeys and/or a camera to be used when in-call with a certain party.
         parameters:
           name: uniquely identifies this callBinding
                 type: string -->
    <callBinding name="">
      <!-- A regular expression that is matched against the sip-uri (username@host) of a remote party
           type: string -->
      <remoteParty>^555@.*$</remoteParty>
      <!-- name of one of the cameras to be shown when in-call with the specified remote party
           type: string -->
      <camera></camera>
      <!-- define custom softkeys to be displayed - up to two during a certain call-state.
           type: list -->
      <softKeys>
        <!-- define a custom softkey to be displayed during certain call-states. -->
        <inCallKey>
          <!-- Describes a single functionkey.
               keyNumber: The number of the key. Uniquely identifies a key within a module.
               label: The name of the key. If starting with @string/ an android resource is used..
               info: Detail info of the key mostly displayed on a second line. If starting with @string/ an android resource is used.
               icon: The icon of the key, base64 encoded. The icon is scaled to fit the display container. If starting with @drawable/ an android resource is used.
               parameters:
                 keyNumber: The number of the key. Uniquely identifies a key within a module.
                            type: integer
                            minimum: 1
                 label: The name of the key.
                        If starting with @string/ an android resource is used.
                        type: string
                 info: Detail info of the key mostly displayed on a second line
                       If starting with @string/ an android resource is used.
                       type: string
                 icon: The icon of the key, base64 encoded.
                       The icon is scaled to fit the display container.
                       If starting with @drawable/ an android resource is used.
                       type: string -->
          <key keyNumber="1" label="" info="" icon="">
            <!-- Reference to the text element of the template name.
                 type: string -->
            <templateName></templateName>
            <!-- type: list -->
            <parameters>
              <!-- parameters:
                     name: type: string
                     value: type: string -->
              <parameter name="" value="">
              </parameter>
            </parameters>
          </key>
          <!-- List of call-states
               type: list -->
          <callStates>
            <!-- "State of a call. E.g.: a new outgoing call starts with ringing and when accepted becomes connected." "Note: When you press hold on your device, the call's state will be holding. But when instead the other" "      party holds you, the state will stay connected"
                 type: enum
                 accepted values:
                   calling
                   ringing
                   holding
                   connected
                   disconnected -->
            <callState>calling</callState>
            <callState>ringing</callState>
            <callState>holding</callState>
            <callState>connected</callState>
            <callState>disconnected</callState>
          </callStates>
        </inCallKey>
      </softKeys>
    </callBinding>
  </callBindings>
  <!-- decide whether the reached target or the initially called target should be used in the calllog.
       the default will show the called target.
       Set to true, the config will lead to the reached target stated in the calllog, while the initially called number can be found in the via section of the calllog details.
       type: boolean -->
  <callLogWithReachedTarget>false</callLogWithReachedTarget>
  <!-- Calls received or started by the phone are logged so they are available in the call-log e.g. to call back a missed call or redial a formerly called party.
       type: boolean -->
  <logCalls>true</logCalls>
  <directCall>
    <!-- type: string -->
    <target></target>
    <!-- the time [s] after which the call will be started
         type: integer
         minimum: 1
         maximum: 60 -->
    <timeout>10</timeout>
  </directCall>
</telephony>