A phone is an internal number that rings a device. Every desk phone, softphone or mobile app that registers with the PBX needs its own phone account, and an external phone lets an internal number ring a mobile or another system. Phones are managed under Accounts → Phones.

Changes to phones take effect after you apply them, see Applying changes.

Phone types

TypeUse it for
SIP phoneDesk phones, softphones and apps that speak SIP. This is the usual choice.
IAX phoneDevices or other Asterisk systems that speak IAX2 (port 4569 UDP).
External phoneAn internal number that forwards to a number outside the PBX: a mobile number dialled through a provider, or a SIP or IAX address (user@host). It has no password and does not register.

The type is chosen with the buttons SIP phone, IAX phone and External phone above the list and cannot be changed later. To change it, create a new phone and delete the old one.

Phone list

The list shows the phones sorted by number, 50 to a page. The search field above it finds phones by extension, name or description; how searching and paging work is described in Lists. The table has these columns:

ColumnMeaning
ExtensionThe internal number. Click it to edit the phone.
NameThe caller ID name.
TypeSIP, IAX or External.
StatusFor SIP phones registered (with the address of the device) or not registered; for IAX phones the peer state; for external phones the number or address they forward to. The column refreshes every 15 seconds. Asterisk down means the telephony service is not running.
VoicemailA mail icon when the phone has a voicemail box.
DescriptionYour note.

The buttons at the end of each row edit, disable/enable and delete the phone. A disabled phone keeps its settings but is left out of the configuration: it cannot register and cannot be called. Deleting a phone also removes the incoming routes and IVR keys that pointed to it or to its voicemail box; the fixed destinations of IVR menus and business hours that pointed to it fall back to Hang up.

The currently registered devices and active calls are also shown under Status → Calls & Registrations.

Add or edit a phone

The form has up to four tabs. External phones only have the first two.

General

FieldMeaningDefault
NumberThe internal number (1–20 digits) used to dial this phone. For SIP and IAX phones it is also the user name the device registers with. It must not be used by another phone, call group, conference room, application, IVR menu, business hours feature code or the call parking range.next free number from 101
Caller ID nameThe name shown to the people this phone calls, for example Anna Meier. It must not contain " < > ; \.–
PasswordSIP/IAX only. The password the device registers with, 4–128 characters without spaces, quotes, ; or \. A strong random password is filled in for new phones; Generate creates a new one, the eye button shows it. When editing, leave the field empty to keep the stored password.generated, 16 characters
Reach this phone viaExternal only: a provider (the number is dialled through a provider), SIP URI (user@host) or IAX URI (user@host).a provider
Number / URIExternal only: the phone number to dial (digits, optionally with a leading +, * and #) or the address user@host.–
ProviderExternal only, with a provider: the provider that dials the number. If that provider is deleted, the external phone is disabled.–
LanguageLanguage of the announcements this phone hears (voicemail, prompts, numbers read out).English
Ring time (seconds)How long the phone rings before the call goes to voicemail (5–600). Empty means the phone rings until the caller hangs up.empty
DescriptionA note for your reference only.–
Reachable from outside (public direct dial)Callers from providers or SIP addresses may call this phone directly by its number.off
Public nameShown when the phone is reachable from outside: an alias for the public context, for example sales for sip:sales@pbx. Letters, digits and . _ + -. Empty uses the number.empty

Voicemail & notifications

FieldMeaningDefault
Enable voicemailGives the phone a voicemail box. Calls that are not answered within the ring time, or that find the phone busy, go to the box. Users listen to their messages by dialling 000086.off
Voicemail PINThe digits the user enters to open the box. A random 4-digit PIN is suggested for new phones.generated
Send voicemail to e-mailNew messages are sent to this address (with the recording attached, depending on the settings under Services → Voicemail). Requires working e-mail, see Services → Notifications.empty
E-mail notification on missed callsSends an e-mail for every call this phone did not answer.off
Notification addressWhere missed call e-mails go. Required when the option above is on.–
E-mail languageLanguage of the voicemail and missed call e-mails. The texts can be changed under Services → Voicemail.Same as phone language

Outgoing calls

SIP and IAX phones only. This tab lists the configured providers.

FieldMeaningDefault
Block providersThe phone cannot place outgoing calls through the selected providers, for example to keep a lobby phone internal.none
Outgoing caller ID per providerOne field per provider. A caller ID such as Sales <4930123456> (or just a number) sent when this phone calls through that provider. It overrides the provider’s Outgoing caller ID setting. Empty uses the provider setting.empty

Which numbers go to which provider is set by the provider’s dial patterns.

Codecs & advanced

SIP and IAX phones only. The defaults suit most devices.

FieldMeaningDefault
CodecsThe audio and video codecs offered to the device, in order of preference (drag to reorder). Audio: ulaw, alaw, g722, opus, gsm, g726, g729, ilbc, speex, slin. Video: h264, vp8, vp9, h263. At least one is required.g722, alaw, ulaw, opus
DTMF modeSIP only. How key presses are transmitted: RFC 4733 (RFC 2833), In-band, SIP INFO or Auto. Change it only if key presses in menus or voicemail are not recognised.RFC 4733
Qualify interval (s)How often the PBX checks that the device is reachable (0–3600). 0 disables the check. For IAX phones any value other than 0 just turns the check on.60
Max. registered devicesSIP only. How many devices may register with this account at the same time (1–10), for example a desk phone and a softphone. When the limit is reached, a new registration replaces the oldest one.1
Busy levelSIP only. With this many concurrent calls the phone is reported busy (1–100), so further callers get the busy treatment (voicemail, if enabled). Empty means no limit.empty
Phone is behind NAT (symmetric RTP, rewrite contact)SIP only. Sends audio and signalling back to the address the packets came from. Keep it on unless the phone is on the same network and you know it is not needed.on
Additional PJSIP endpoint options / Additional IAX peer optionsAdvanced: one key=value per line, appended to the generated endpoint or peer section. Lines starting with ; are ignored.empty

Add a SIP phone

  1. Open Accounts → Phones and click SIP phone.
  2. Keep the suggested Number or enter your own, and type the Caller ID name.
  3. Copy the generated Password (eye button) before you save.
  4. Optionally switch on Enable voicemail on the Voicemail & notifications tab.
  5. Click Create phone, then apply the changes.
  6. Configure the device as described below.

Configure a SIP phone or softphone

Enter these values in the account settings of the phone or softphone:

Setting on the deviceValue
Server, registrar, domain or proxyThe IP address (or host name) of the PBX.
User name, user ID, authentication userThe phone’s Number, for example 101.
PasswordThe phone’s Password.
Display nameAnything; the PBX uses the Caller ID name.
Transport and portUDP on port 5060. TCP (also port 5060) and TLS (port 5061) work when they are enabled under Advanced → SIP.
Voicemail number000086

After the device registers, its status in the list changes to registered. Dial 00003246 (the echo test) to check audio in both directions.

If the phone does not register, check the user name and password first, then the firewall: the SIP port may be limited to certain networks under Advanced → Firewall, and repeated wrong passwords can get a device’s address banned for a while.

IAX phones are set up the same way: server = the PBX address, user name = the number, the password, port 4569 UDP.