A provider is an account at a VoIP provider or a SIP trunk, or another PBX reached over SIP or IAX. It carries the calls between the PBX and the outside world. Providers are managed under Accounts → Providers.

Outgoing calls are routed by the provider’s dial patterns, incoming calls by its incoming routes. Changes take effect after you apply them, see Applying changes.

Provider list

Click SIP provider or IAX provider above the list to add a provider. The list shows:

ColumnMeaning
NameYour name for the provider. Click it to edit. A disabled badge marks disabled providers.
TypeSIP or IAX.
StatusWhether the provider is registered right now, for example Registered or Rejected. For a provider without registration it shows whether it can be reached, for an IAX provider the state of the trunk. not loaded means the configuration with this provider is not applied yet, Asterisk down that Asterisk is not running. The column is updated every 15 seconds; disabled providers show a dash.
HostHost name or address, with the port if one is set.
UsernameThe account user name.
Dial patternsThe outgoing patterns, or none (then the provider is not used for outgoing calls).
IncomingThe number of incoming routes.

The search field above the list finds providers by name, host or user name; how searching and paging work is described in Lists.

The buttons at the end of each row edit, disable/enable and delete the provider. A disabled provider does not register and is not used for calls. Deleting a provider also disables the external phones that dialled through it.

The same states, together with the phones and the active calls, are shown under Status → Calls & Registrations.

Add or edit a provider

Your provider’s documentation or customer portal lists the values you need: the server (host), your user name and password, and sometimes a separate authentication user or a required From domain. The form has four tabs.

Account

FieldMeaningDefault
NameYour name for the provider, shown in lists and pickers.–
HostHost name or IP address of the provider’s server, for example sip.provider.example.–
PortPort of the server. Empty uses the default: for SIP the host name is looked up via DNS SRV first if Use DNS SRV lookups is on under Advanced → SIP, otherwise 5060 (5061 for TLS); 4569 for IAX.empty
TransportSIP only: UDP, TCP or TLS. Choosing TCP or TLS also enables that transport on the PBX.UDP
UsernameYour account user name at the provider.–
PasswordThe account password. When editing, leave it empty to keep the stored one.–
Register with the providerThe PBX registers with the provider so that incoming calls reach it. Switch it off for providers that authenticate by IP address.on
Authentication userSIP only. Only if the provider gives you an authentication name that differs from the user name.the user name
From userSIP only. The user part of the From header of outgoing calls.the user name
From domainSIP only. The domain of the From header.the host
AuthenticationIAX only: MD5, Plain text or RSA.MD5

Outgoing calls

FieldMeaningDefault
Dial patternsOne pattern per line. A phone dialling a number that matches a pattern places the call through this provider. See Dial patterns.empty
Failover providerAnother provider that takes the call when this one is unavailable or congested. See Failover.none
Outgoing caller IDuse the phone’s caller ID or fixed caller ID.use the phone’s caller ID
Fixed caller IDWith fixed caller ID: the caller ID sent on every call through this provider, for example Company <4930123456>.–

A phone can override the caller ID per provider and can be blocked from using a provider, see Outgoing calls in the phone settings. Many providers only accept or show caller IDs that belong to your account.

Incoming calls

FieldMeaningDefault
RoutesPairs of an incoming number pattern and a destination. See Incoming routes.none
Public numberYour main number at this provider. Informational only.empty
Incoming caller IDChanges the caller ID of incoming calls: unchanged, replace name with number, replace with text or prepend text to name (for example Hotline to see which line was called).unchanged
Caller ID textThe text for replace with text and prepend text to name.–

Codecs & advanced

FieldMeaningDefault
CodecsCodecs offered to the provider, in order of preference (drag to reorder). Use what the provider supports; G.711 (alaw in Europe, ulaw in North America) works almost everywhere.alaw, ulaw, g722
LanguageLanguage of the announcements callers from this provider hear.English
DTMF modeRFC 4733 (RFC 2833), In-band, SIP INFO or Auto.RFC 4733
Qualify interval (s)How often the PBX checks that the provider is reachable (0–3600, 0 = off).60
Provider is reached through NAT (symmetric RTP)Sends audio back to the address it came from.on
Additional optionsAdvanced: one key=value per line, appended to the generated endpoint (SIP) or peer (IAX).empty

Dial patterns

A dial pattern decides which numbers dialled on a phone leave the PBX through this provider, and how the number is changed before it is sent. The syntax is:

[prefix to add+][prefix to strip|]pattern

The pattern itself uses the Asterisk pattern characters:

CharacterMatches
0–9, *, #Exactly this character
XAny digit 0–9
ZAny digit 1–9
NAny digit 2–9
[1-5], [13]One digit from the range or list
.One or more further characters
!Zero or more further characters

The digits before | belong to the pattern but are removed before dialling. The digits before + are put in front of the number. Each of | and + may appear only once.

PatternThe phone dialsSent to the provider
X.03012345670301234567 (unchanged)
0|X.0 03012345670301234567 (outside line 0 removed)
49+0|X.030123456749301234567 (leading 0 replaced with 49)
112112112 (emergency number only)
0|[1-9]XXX.0 17012345671701234567
0|00X.0 00414412345670041441234567 (international calls)

Tips:

  • A typical setup uses an outside line prefix: 0|X. on the main provider sends everything that starts with 0 there.
  • When several patterns (of one or several providers) match a number, the most specific pattern wins, so 0|00X. for international calls beats 0|X..
  • The same pattern cannot be used by two providers; the form reports which provider already has it. Use the failover provider for a backup route instead.
  • Always add the emergency numbers (for example 112, 110, 911) if phones dial them without a prefix.
  • Patterns must not overlap with internal numbers that should stay internal. Internal numbers are checked first when a phone dials.
  • Numbers dialled with a leading + are matched after the + has been replaced, see Dialplan → Transfers & Parking.

Incoming routes

Incoming routes decide where a call from this provider goes, based on the number that was called (the DID). Click Add route to add a row with a pattern and a destination:

PatternMatches
empty (all numbers)Every incoming call. Use it if you have one number, or as a fallback.
4930123456Exactly this number.
49301234XXA pattern, with the same characters as dial patterns (no | and no +).

The destination can be a phone, a call group, a conference room, an application, an IVR menu or business hours, see Destinations.

  • Several routes with the same pattern and phones as destinations ring those phones at the same time.
  • If no route matches, the called number is looked up among the objects that are reachable from outside (public direct dial): if it equals the number or public name of such a phone, call group, application, conference room or IVR menu, the call goes there.
  • Some providers always send your account user name instead of the dialled number. A route with an empty pattern catches these calls too.

Route an incoming number to an IVR menu

  1. Create the menu under Dialplan → IVR Menus.
  2. Open the provider, tab Incoming calls, click Add route.
  3. Enter the number (or leave the pattern empty for all numbers) and choose the menu as destination.
  4. Save and apply the changes.

To answer with a different menu outside office hours, route the number to business hours instead, with one menu as When open and another as When closed.

Failover

If a call through this provider fails because the provider is unavailable or congested, the PBX tries the Failover provider. The failover provider must be enabled and have a dial pattern that matches the dialled number; its own pattern rules (strip and add prefixes) are applied. A busy line or a call that is not answered is not retried.

Several accounts at one provider

You can add several SIP accounts with the same host, for example one per number. The PBX tells incoming calls apart by the account user name, so each account’s incoming routes apply to its own calls.