Release notes Compass

Changelog Compass 2017d

Planned release: November 2017

Compiled by: Matthias van der Heide

Latest update: November 17th, 2017


In this release we updated many of the components that relate to making phone calls.

Not only did we upgrade to a newer version of Asterisk, but we removed the dependency on Freeswitch, and re-wrote the module that links Asterisk to the rest of the platform.

Important changes

  • New system prompts in Dutch and English
  • When a queue call is picked up, the other phones will stop ringing immediately
  • API dial command has the correct call events
  • API dial calls can now be transferred
  • Identity call recordings from a queue will report the correct call ID in the call recording email
  • Call recordings do not record audio while the call is on hold
  • Compass will no longer offer video codecs by default on every outgoing call. Only when a phone requests them, will they be offered to the remote party
  • Default NAT timeout changed to 25 seconds (was 45)
  • Provisioned phones that are still in state 'active' will be de-provisioned within a week for security reasons
  • All service codes (*1, et cetera) get logged in the events, but not in CDRs
  • Improved quality for call recordings
  • Possible to login user directly by dialling *1*extension*pincode#
  • Conference box now also has music 
  • Voicemail IVR menu structure changed

Changes to the REST API (v2)

  • None at this time.


  • Removed service codes *74 and *84

Known issues

  • RM-2868 Semi-attended transfer generates an extra call recording
  • RM-2893 CDRs for a (un)attended transfer of an API dial is incorrect
  • RM-2899 Some prompts for voicemail menu are incorrect
  • RM-2900 First caller waiting in a queue gets no announcement

Changes (Merge Requests)

New features (0)

  • None.

Changed behaviour (2)

  • MR-334 Changed NAT timeout to 25 seconds for Snom and Yealink phones
  • MR-338 Yealink source port changed from 5060 to 55060
  • Voicemail can be fast-forwarded by 5 seconds (was 1 second)
  • After a voicemail element, the dialplan will now continue
  • User-agent of PBX is now "Compass PBX", was "Canens vPBX"

Performance / stability / system administration / development (5)

  • Upgrade to Asterisk 15
  • Implement all features using Asterisk
  • Remove Freeswitch
  • Rewrite ITI
  • Preparations for WebRTC support
  • MR-330 Autodetect repo proxy
  • MR-344 Cleanup PhoneController
  • MR-353 Log all failures in external Asterisk scripts
  • MR-360 Add script for enabling/disabling PBX
  • MR-361 Add cronjob to disable manufacturer provisioning

Changelog Compass 2017c

Planned release: August 30th, 2017

Compiled by: Matthias van der Heide

Latest update: August 23rd, 2017


This version of Compass focuses mainly on maintenance.

We fixed several issues identified earlier this year, and added necessary features to add more users to the platform.

Important changes

  • Resellers can now configure an address to be used as source for call recording emails and voicemail emails (for example '')
  • Provisioning for Snom M3 and M9 removed
  • MR-311 Multi-level reseller

Changes to the REST API (v2)

  • Same as 2017b-2, plus:
  • Auto-fill contact field for new resellers


  • Removed Snom m3/m9 provisioning; they can still be added as 'Generic DECT' phones

Changes (Merge Requests)

New features (2)

  • MR-296, MR-314 No-reply address for reseller users
  • MR-318 Add shortcode to dpSwitch in API
  • MR-311 Multi-level reseller

Changed behaviour (8)

  • MR-285 Remove SNOM m3/m9 provisioning (RM-2634)
  • MR-303 Fix edit function keys screen for legacy phones (RM-2133)
  • MR-306 Fix cancel button when editing voicemail (RM-2799)
  • MR-308 Manuals open in a new window
  • MR-317 Fix api get/set callrecording
  • MR-320 Different ringer for internal calls on Yealink phones
  • MR-322 Auto-fill contact address for resellers created in the API (RM-2810)
  • MR-326 Fix cancel button when editing root reseller (RM-2814)

Performance / stability / system administration / development (17)

  • Changed the way companies are assigned to PBX'es (Dispatcher)
  • MR-299 Updated XMPP API documentation
  • MR-301 Refactory GUI url
  • MR-302 Web integration tests
  • MR-307 Fix CI test cases
  • MR-309 Fix ds_reload script (RM-2800)
  • MR-313 Refactor i18n regen script
  • MR-315 Gitlab MR template
  • MR-316 Add tests for info services codes to testplan
  • MR-321 PHP Static Analysis tools (RM-2807)
  • MR-325 Release scripts (RM-2804)
  • MR-328 Rewrite 'find next identity order' code
  • MR-329 Increase maximum mail size to 25 MB (RM-2816)
  • MR-330 Package sources script
  • MR-331 Fix webtests
  • MR-332 Fix kamailio pv buffer space to format large queries (RM-2819)


Changelog Compass 2017b-2

Release date: July 5th, 2017

Compiled by: Matthias van der Heide

Latest update: July 5th, 2017


Added and fixed two calls in the REST API v2.

Changes to the REST API (v2)

  • The dialplan switch has been extended with the field ‘shortcode’. This can be used to reliably lookup a dialplan switch, even when its ID changed after editing a dialplan in the webinterface.
  • The setting ‘recording’ has been added to identities, and can be changed through the API.
  • The setting ‘recording’ has been fixed for external numbers.

The new fields are mandatory when patching these resources. This means you might have to update your scripts, even when you don’t use this particular field.

Changes (Merge Requests)

New features (1)

  • MR-318 Add 'shortcode' to dialplan switch in API

Changed behaviour (1)

  • MR-317 Fixed get/set callrecording on identities and externalNumbers


Changelog Compass 2017b

Release date: June 14th, 2017

Compiled by: Matthias van der Heide

Latest update: June 14th, 2017


In this update of Compass we lay the groundwork for an exciting new feature: multiple trunk support. Since the beginning of Compass we have supported only one specific trunking method. This made it a challenge to connect to different trunk providers.

In addition we fixed some bugs in the webinterface, cleaned up old code and updated many software packages to their newest version.

New features

  • Basic support for multiple trunks; this is visible to resellers only

Important changes

There are no important changes in external behaviour in this version of Compass.

Changes to the REST API (v2)

  • New calls added to support trunking


  • REST API version 1 will be deprecated in an upcoming update. Users of this API version are advised to:
    • Start using versioning headers in their HTTP requests. See the API documentation in Compass for details.
    • Upgrade their software to use API version 2.

Changes (Merge Requests)

New features (1)

  • MR-218 Multiple trunk support

Changed behaviour (2)

  • MR-275 Fix add phone bug (RM-2756)
  • MR-295 Fix phone statistics AC check

Performance / stability / system administration / development (13)

  • MR-264 Remove Clair specific code
  • MR-279 [tests] Sipit improvements
  • MR-280 [web] Update sox invocation
  • MR-282 [web] Cleanup web directory
  • MR-286 Daily proxy restart
  • MR-287 [clerk] Clerk loglevel
  • MR-288 Update XMPP documentation
  • MR-291 Update XMPP documentation
  • MR-292 Update XMPP documentation
  • MR-293 Optimize prunecdrs script to reduce memory usage
  • MR-297 [api] Refactor getFullResource function
  • MR-304 Upgrade docker (RM-2709)
  • MR-305 Package pinning update


Changelog Compass 2017a (Dutch)

Geplande release: 3 mei 2017

Opgesteld door: Matthias van der Heide

Laatst gewijzigd: 13 april 2017


De afgelopen maanden is hard gewerkt aan het Compass platform. De ervaringen die we hebben opgedaan met het Ubuntu operating system hebben we verwerkt in diverse verbeteringen op het vlak van performance en stabiliteit.

Nieuwe features

  • Toestelstatistieken: krijg gemakkelijk inzicht in de gebruikte toestellen (merken, modellen, firmwares)
  • E-mailnotificaties van voicemails zijn nu ook in het Nederlands beschikbaar
  • Ondersteuning voor WebSockets toegevoegd

Belangrijke wijzigingen

  • Bij CDR-events is de kolomvolgorde aangepast
  • Het is niet meer mogelijk toestellen van het type Snom M3/M9 toe te voegen
  • Wachtmuziek wordt afgespeeld in alfabetische volgorde in plaats van willekeurig
  • De naam van een company of reseller hoeft niet meer uniek te zijn

Wijzigingen in de REST API (v2)

  • De namen van entities (user, company, reseller) kunnen gewijzigd worden (MR-274)
  • Bij een reseller kan een lijst van companies opgevraagd worden (MR-217)
  • Van de rootreseller kan een lijst met resellers opgevraagd worden (MR-217)
  • Bij een reseller kan een lijst met resellergebruikers opgevraagd worden (MR-217)
  • Op plekken waar een optionele parameter meegegeven kan worden (bijvoorbeeld cli in /company/{id}/createUser) mag nu zowel null als een lege string ('') worden meegegeven (MR-246)
  • Wanneer ten onrechte null als invoer wordt gegeven, retourneert de REST API voortaan HTTP-error 400 in plaats van 500 (MR-253)
  • Documentatie-aanpassing: /user/lookup geeft een redirect naar een user terug in plaats van de user zelf

Changes (Merge Requests)

Nieuwe features (4)

  • MR-214 [web] Phonestats
  • MR-227 [puppet] NTP setting
  • MR-260 [web] Voicemail mailtaal
  • MR-266 [uc] Ejabberd websockets

Gewijzigd gedrag (24)

  • MR-183 [web] Fix #2607 by implementing custom email/hostname validators (RM-2607)
  • MR-184 [web] External nummers sortering (RM-2569)
  • MR-193 [web] Edit identity notice en error. (RM-2637)
  • MR-199 [web] URL trailing slash fix (RM-2653)
  • MR-203 [web] Nginx Gzip
  • MR-206 [web] Remove m3/m9 from list in webinterface
  • MR-217 [api] ResellerOps wijzigingen
  • MR-219 [rest] REST docs updated (RM-2686)
  • MR-220 [web] Taal bij company/reseller weergeven
  • MR-223 [web] Web access control (RM-2401, RM-2408)
  • MR-224 [web] Email resellers (RM-2680)
  • MR-234 [web] hide cdr link for resellers
  • MR-235 [web] web acl navigatie (RM-2602)
  • MR-245 [clerk] fix kolomvolgorde (RM-2716)
  • MR-246 [rest] Rest HTTP null proxy (RM-2563)
  • MR-248 [web] Sip domein niet meer aanpasbaar door resellers (RM-2614)
  • MR-253 [api] api null checks
  • MR-265 [api] Fix api enrich for reseller sip domain
  • MR-268 [api] Uniqueness van company full name
  • MR-271 [web] menu items
  • MR-272 [pbx] wachtmuziek afspelen op alfabetische volgorde
  • MR-273 [web] vertaling organisaties (RM-2742)
  • MR-274 [api] Modify company fullname
  • MR-289 [web] Email hostname validation

Performance / stabiliteit / systeembeheer / development (40)

  • MR-176 [uc] Lisa nullpointer exceptions
  • MR-179 [api] api-enum-fixes
  • MR-180 Daemon timeout fix
  • MR-194 Enable coredumps on icegridnode
  • MR-202 PHP notices op staging
  • MR-204 cmpd query bugfix
  • MR-205 Lisa Gradle
  • MR-208 Loadtests
  • MR-213 docker subnet
  • MR-215 Freeswitch logging
  • MR-216 cmpd herstartgedrag
  • MR-221 [api] API delete moh/did
  • MR-222 Java 8
  • MR-225 Fix puppet warnings
  • MR-226 [api] API for RM-2667
  • MR-228 crmSync actie verwijderen uit Compass Ubuntu (cleanup)
  • MR-229 Jooq update
  • MR-231 API Standalone
  • MR-232 refactor initdb voor tests
  • MR-236 [api] API multithreaded
  • MR-243 [rest] rest logging start of request
  • MR-249 [api] API Database connection pools
  • MR-250 [uc] Lisa NPE
  • MR-252 [web] Verwijder Apache
  • MR-254 [web] Remove pdf symlinks
  • MR-256 [web] Phone 404
  • MR-257 ds_reload script
  • MR-258 [web] Webinterface cleanup
  • MR-259 [web] Franse vertaling verwijderd
  • MR-261 Lisa-sync bij import
  • MR-269 [web] Voicemail controller refactoring
  • Styling naar IPerity Roze (geen MR)
  • MR-277 Asterisk ami stats user
  • MR-278 Systemd
  • MR-281 Hotfixes true voor import
  • MR-283 [web] CSS fix
  • MR-284 Kamailio stats
  • MR-290 Increase Kamailio private memory
  • MR-291, MR-292 [web] XMPP Documentatie


Have more questions? Submit a request


Please sign in to leave a comment.