Howto:V13 MyApps Cloud - connecting Yealink-phone

From innovaphone-wiki

Jump to: navigation, search

Contents


Applies To

This information applies to

  • Howto connect a Yealink phone to a myApps Cloud PBX
  • myApps Cloud v13

The article describes how to configure a Yealink Phone to register and connect to myApps Cloud

To manually connect a Yealink phone to the myApps Cloud PBX, a two part configuration is required. The first part covers minor adjustments on the PBX object. The second part describes the configuration of the Yealink phone.

The document does not describe (yet), how to use the innovaphone Yealink App, to conduct a configuration in an more automated manner. For further information, refer to here.

Disclaimer

Yealink is a 3rd party brand. As such innovaphone is not liable for any malfunction of the Yealink firmware itself, or malfunction caused through or due to changes in the Yealink firmware.

Considerations for this example configuration

For this configuration, were working with various the Yealink desk phones, using the major firmware release 84.
Please keep in mind, each Yealink Firmware consists out of 4 numbers, such as 52.84.0.125

  • 52: phone-type (52 stands for T21(P))
  • 84: the major firmware release
  • 0: Yealink firmware (Yealink = 0, different numbering might be a different distribution)
  • 65: the minor firmware / service release

The parameters below are innovaphone default settings. These settings might be different in your specific cloud environment. Thus, please check your documentation and take a note of the corresponding parameters of your specific cloud instance.

  • This example uses a secure connection, via SIP/TLS
    (recommended method for connecting to the myApps Cloud).
  • In order to establish a secure TLS connection between the Yealink Phone and the myApps Cloud Platform, we rely on standard Yealink device certificates. These certificates are present on all Yealink devices and the myApps Cloud Platform. Therefore, no need to install any certificates manually on the Cloud PBX.
  • The system name of the PBX in this example is: company25.org
  • The URL or the respective PBX in this example is: 01234-pbx.innovaphone.com
    (in Yealink terminology it is the 'Outbound Proxy Server')
  • Mac address of the Yealink phone (usually on the back of the device): 80:5F:C0:31:D5:34
  • Check STUN and TURN settings of the respective PBX (probably you will find a different setting, please check your documentation or your PBX settings: PBX Admin UI > General > STUN)
    • used STUN Server: stun.innovaphone.com
    • used STUN Port: 3478
    • used TURN Server: turn.innovaphone.com
    • used TURN Port: 3478
    • used TURN Username: *****
    • used TURN Password: *****

Part 1 - Configuration on the myApps Cloud PBX

Step 1 - Known Yealink Issue and Workarounds

- IMPORTANT -

  • On the most recent firmware of Yealink phones, there seems to be an issue with SIP Digest Access Authentication.
  • The error manifests itself, after a repeated call to the same destination, the phone shows: "Digest replay attack detected".
  • As a workaround, the Digest Authentication Reply Check can be disabled on the PBX, with the following procedure:
    • In the advanced interface of the PBX, go to Maintenance > Diagnostics > Command and enter the following commands:
    •  !config change TSIP /disable-digest-replay-check /log on
    •  !config change SIPS /disable-digest-replay-check /log on
    •  !config write
    •  !config activate
  • When transferring a call on a Yealink phone, no MOH is played by the PBX to the remote party.
    • When you put a call on hold on a Yealink phone, no MOH is played by the PBX to the remote party. Per default the Yealink sends sendonly instead of inactive when the call is put on hold. This would mean that the Yealink who puts the call on hold, should generate its own MOH and sends this to the remote party (sendonly). You can change the configuration in the Yealink phone to send inactive instead of sendonly as as described here or configure a MOH URL in the Yealink phone.

Step 2 - Setting of the PBX User Object

Part 1, Step 2
Part 1, Step 2
  • Open the PBX User Object, of the respective Yealink User
  • In the section Devices, please fill the fields as following:
    • Hardware Id: Enter the Yealink's mac address, e.g.: 805fc031d534 (to allow a phone, to register to the PBX using the mac address, instead of username and password, minor characters, no colon)
    • Name: The name of the App, e.g. 'Yea-T21', which later creates an App, to remote control the Yealink Phone through myApps Client (can be defined freely, without quotation marks)
    • App: Enter keyword 'phone' (without quotation marks)
    • TLS only: 'on'
    • Reverse Proxy: 'on'
    • Media Relay: 'on'

Following press <OK> to save and close this page.

Part 2 - Configuration of the Yealink Phone

IMPORTANT:

  • Prior to proceed with the configuration of the Yealink phone, please make sure you Yealink phone contains the most recent Firmware.
  • Otherwise, download the required firmware (at the manufacturer pages) and update manually.

Step 1 - Upper Tab: Account

Part 2, Step 1 a
Part 2, Step 1 a
  • Side tab: Register
    • Display Name: User Name of the PBX User, e.g.: John (essentially not necessary)
    • Register Name: MAC address of the Yealink phone (minor characters, no colon)
    • Username: MAC address of the Yealink phone (minor characters, no colon)
    • Password:
    • Server Host: System name of the PBX, e.g.: company25.org
    • Port: 0
    • Transport: TLS
      ...
    • Enable Outbound Proxy Server: Enabled
    • Outbound Proxy Server: URL or the respective PBX, e.g. 01234-pbx.innovaphone.com
    • Port: 5061
      ...
    • NAT: STUN

Following press <Confirm> to save changes.

  • Side tab: Advanced
    ...
Part 2, Step 1 b
Part 2, Step 1 b
    • RTP Encryption (SRTP): Compulsory
      ...

Following press <Confirm> to save changes.

Step 2 - Upper Tab: Network

Part 2, Step 2
Part 2, Step 2
  • Side tab: NAT
    • Manual NAT
      • Active: Disabled
    • ICE
      • Active: Disabled
    • STUN
      • Active: Enabled
      • STUN Server: stun.innovaphone.com (same STUN Server as configured on your PBX, please verify)
      • STUN Port: 3478 (default value, same STUN Port as configured on your PBX, please verify)
    • TURN
      • Active: Enabled
      • TURN Server: turn.innovaphone.com (same TURN Server as configured on your PBX, please verify)
      • TURN Port: 3478 (default value, same STUN Port as configured on your PBX, please verify)
      • Username: *****
      • Password: *****

Following press <Confirm> to save changes.

Step 3 - Upper Tab: Features

Part 2, Step 3
Part 2, Step 3
  • Side tab: General Information
    • RFC 2543 Hold: Enable
    • Use Outbound Proxy In Dialog: Enable
      ...

Following press <Confirm> to save changes.

Step 4 - Upper Tab: Security

Part 2, Step 4
Part 2, Step 4
  • Side tab: Trusted Certificates
    • Only Accept Trusted Certificates: Disabled
    • Common Name Validation: Disabled
    • CA Certificates: All Certificates
      ...

Following press <Confirm> to save changes.

Step 5 - Upper Tab: Settings

Part 2, Step 5
Part 2, Step 5
  • Side tab: Upgrade

Following press <Reboot> to restart the device.

Step 6 - Upper Tab: Status

Part 2, Step 6
Part 2, Step 6

Finally, please check if the SIP-URI is properly constructed (meaning: [device-mac-address]@[system-name-of-PBX])

  • Side tab: Status
    • Account Status
      • Account 1: 805fc031d534@company25.org : Registered

Part 3 - Testing

  • Initiate a Test Call to verify your configuration, where the audio stream is terminated on the myApps Cloud PBX (termination in a different network).
    This might be a call to a waiting queue, to a voicemail Object or to an echo interface.
    • If there is no audio:
      • check the STUN & TURN setting on the Yealink phone.
      • check if the PBX user object uses the Media Relay: 'on' (see above, part 1, step 2)
  • Repeat the above test call to the same destination (e.g. redial key)
    • If the phone shows the error: "Digest replay attack detected"
      • proceed to disable the Digest Authentication Reply Check (see above, part 1, step 1)
Personal tools