ScopTEL - Yealink Distinctive Ringing Configuration

ScopTEL - Yealink Distinctive Ringing Configuration


Purpose


Create a unique custom ring tone for each Yealink phone on the network

Pre-Requisites

scopserv-telephony25-6.9.3.7.20200305
.wav files encoded in PCM Uncompressed 16 bit, 8K sampling, Mono
Using free software such as: https://www.nch.com.au/switch/index.html
.wav files must be uploaded to the server’s /tftpboot/ directory using the GUI Tools|File Manager|TFTP Directory or using WinSCP prior to configuring any extensions.




Extensions|Phone Options|Global Custom (ALERT_INFO)

Following these instructions will override any Device/Vendor specific Ring tone options
Edit your Yealink extension using the Telephony Extensions Manager and click the Phone Options tab.
SIP Alert (Auto Answer/Distinctive Ring)
Change the Device type to Custom (ALERT_INFO) using the drop list selector
For the desired Ring Tone section you must enter the path to the ScopTEL server’s /tftpboot/ web path. Doing so will replace the default dial plan with a customization for any extension.
The text format must match this syntax: Alert-Info: http://<Server IP>:<GUI Listen Port>/tftpboot/<filename.wav>/info=<filename>\;x-line-id=0 (omit the <> these are used to indicate variables)
As in this working example where the uploaded file name in /tftpboot/ is caramba.wav Alert-Info: http://192.168.0.1:5555/tftpboot/caramba.wav/info=caramba/;x-line-id=0
Click Save when done
Commit the Telephony changes




Extensions|Phone Options

You can continue using factory Ring Tones if you choose Custom (ALERT_INFO) if you substitute blank text with Yealink’s default values Bellcore-dr1 Bellcore-dr2 Bellcore-dr3 Bellcore-dr4 Bellcore-dr5
Click Save when done
Commit the Telephony changes



Extensions|Phone Options|Auto Answer|Vendor Specific Device

Following these instructions allows you to set a Custom (ALERT_INFO) for each Ring Tone type while still allowing Auto Answer configurations to work.
Edit your Yealink extension using the Telephony Extensions Manager and click the Phone Options tab.
SIP Alert (Auto Answer/Distinctive Ring)
Change the Device type to Yealink using the drop list selector
Choose any Ring Tone drop list selector and choose the ‘Custom’ option
For the desired Ring Tone section you must enter the path to the ScopTEL server’s /tftpboot/ web path. Doing so will replace the default dial plan with a customization for any extension.
The text format must match this syntax: Alert-Info: http://<Server IP>:<GUI Listen Port>/tftpboot/<filename.wav>/info=<filename>\;x-line-id=0 (omit the <> these are used to indicate variables)
As in this working example where the uploaded file name in /tftpboot/ is caramba.wav Alert-Info: http://192.168.0.1:5555/tftpboot/caramba.wav/info=caramba/;x-line-id=0
Click Save when done
Commit the Telephony changes



Incoming Lines|Destination|Extension(s)|Distinctive Ring (SIP Device)

You can enable Custom (ALERT_INFO) in the drop list if an Incoming Line’s Destination is Extension(s)
The same syntax applies as before.
NOTE: If you Enable Use User-defined Call Forward the extension’s Custom (ALERT_INFO) will take precedence so if you enable the Use User-defined Call Forward option the Extension’s Ring Tone – External Calls text field must be left blank.
Click Save when done
Commit the Telephony changes




Automatic Provisioning System

You may set the Internal Ringer tab options to a Template or Override a Template per MAC address.
In  this example a Yealink MAC is edited and the Override template settings?: [x] option is checked else the MAC will defer to the assigned APS Template.
The Ringtone URL must point to the location of the required file. NOTE: the first time the custom path is executed the phone will download the file before it can be played to the user.
The Ringer Text must match the Text defined in the Extension’s Phone Options
The Ringer File must use the Custom drop list selector and the Custom File name text must also match the Extension’s Phone Options
Click Save when done
Commit the APS changes and reboot or resync the phone to download the new configuration




Debugging

Use the Asterisk CLI with ‘sip set debug peer <peername>’ commands to display the Alert-Info message which will vary depending on your Alert type configuration as in this example:

[Mar  2 11:25:40] From: "Operator" <sip:211@192.168.0.1>;tag=as2bcee56b
[Mar  2 11:25:40] To: <sip:213@192.168.0.101:5060>
[Mar  2 11:25:40] Contact: <sip:211@192.168.0.1:5060>
[Mar  2 11:25:40] Call-ID: 025d39b551267dc52499887f619bcf31@192.168.0.1:5060
[Mar  2 11:25:40] CSeq: 101 INVITE
[Mar  2 11:25:40] User-Agent: Asterisk PBX (ScopServ)
[Mar  2 11:25:40] Date: Mon, 02 Mar 2020 16:25:40 GMT
[Mar  2 11:25:40] Allow: INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY, INFO, PUBLISH, MESSAGE
[Mar  2 11:25:40] Supported: replaces,timer
[Mar  2 11:25:40] P-Asserted-Identity: "Operator" <sip:211@192.168.0.1>
[Mar  2 11:25:40] Content-Type: application/sdp
[Mar  2 11:25:40] Content-Length: 568

The Alert-Info printout will tell you if the correct SIP header is being generated.







    • Related Articles

    • Yealink Distinctive Ringing Configuration

      ScopTEL supports Distinctive Ringing Configurations for: Aastra Cisco Grandstream Polycom Sipura/Linksys Snom Yealink Custom (ALERT_INFO) This document explains how to configure Yealink phones.

    • ScopTEL - DHCP APS Configuration

      DHCP Configuration DHCP detection of new devices when the ScopTEL DHCP server is the only DHCP server on the LAN. During DHCP acquisition a newly installed and supported SIP device can be added to the APS list automatically. DHCP discovery can ...

    • General-Presentation-ScopTEL-ENGLISH

      ScopServ – The Company  ScopServ is a Canadian firm founded in 2004, specializing in information technology.  It designs high-end corporate applications and holds the intellectual property rights for its products and solutions.  A strong actor in ...

    • ScopTEL IP PBX Software - Vegastream Analog Gateway Configuration

      FXO interfaces Also known as POTS line (Plain Old Telephone Service). Also known as 1fl (1 family line). Each FXO line can support one conversation between two parties (Tx and Rx Transmit and Receive). Most business use ‘equivalent lines’ placed into ...

    • Yealink Phones do not download provisioning files after updating to scopserv-telephony25-5.2.24.0.2014060

      During the finalization of APS support for Yealink Version 72 firmware, ScopServ included a configuration line in Yealink <MAC>.cfg files which broke the phone’s ability to download edited <MAC>.cfg files after the initial configuration download.  ...