Onyx VoiceDocumentation
All chapters

Docs / Phone system

Calling features and feature codes

This chapter covers what people do with their phones beyond plain calls: do not disturb, call forwarding, voicemail, ring groups, paging and intercom, call parking and pickup, call recording, hot desking, phone keys that light up, hold music and transfers. It starts with the full list of feature codes, the star codes people dial from any phone of the tenant.

Feature codes

Feature codes work from every phone, softphone and browser softphone of the tenant. Where a code is followed by a number, dial both in one go, for example *72916125550199 to forward every call to 9 + 612 555 0199.

CodeWhat it does
*97Your own voicemail (asks for your PIN)
your own extension numberAlso your own voicemail
*98Any voicemail box (asks for the box number and its PIN)
*76Do not disturb on or off
*31Status: Available
*32Status: Away
*33Status: Lunch
*34Status: Business trip
*30Switch between Away and Available
*67 + numberCall with your number hidden
*1 during a callStart or stop recording the call
*72 + numberForward every call to that number
*73Stop forwarding every call
*90 + numberForward calls when you are busy
*91Stop the busy forward
*52 + numberForward calls you do not answer
*53Stop the no-answer forward
*8Pick up any phone that is ringing in the company
** + extensionPick up that extension's ringing call, for example **102
*80 + extensionIntercom: that person's phone answers on speaker, for example *80102
700Park a call: transfer the call to it. Dialled from an idle phone: pick up the parked call (the first slot)
701 to 720Pick up the call parked in that slot (**701 too)
*55Log in at a hot desk (extension, then voicemail PIN)
*56Log out of a hot desk
*27 + business hours numberForce it closed, for example *27500; dial again to follow the schedule
*28 + business hours numberForce it open, for example *28500; dial again to follow the schedule
*45Queue agents: log in to or out of all your queues
*46Queue agents: pause or resume
*222 + extensionSupervisors: listen in on that person's call
*223 + extensionSupervisors: coach (only the agent hears you)
*224 + extensionSupervisors: join the call
*43Echo test: what you say comes back, to check audio
*60Speaking clock in the tenant's time zone
## during a callBlind transfer, on phones without a transfer key
*2 during a callAttended transfer, on phones without a transfer key

Queue agent and supervisor codes are explained in Call centre, the keys inside a conference room in Conference rooms and the switchboard, and *27/*28 in Forcing open or closed.

A forwarding target is dialled the way the person would dial it from their own phone. An outside number therefore includes whatever your outbound routes expect: with a "9 for an outside line" route, forwarding to 612 555 0199 is *72916125550199. After setting a forward, the phone reads the number back.

Do not disturb, forwarding and business hours overrides set from a phone are saved like changes in the console, and show in Change history as made by "phone".

Do not disturb

*76 switches do not disturb on and off; the phone says "do not disturb activated" or "de-activated". The person can also tick Do not disturb in the portal, and an administrator in the Call handling card of the extension.

While it is on, the person's phones do not ring. Callers are treated as if the line were busy: they go to the busy forward if one is set, otherwise to voicemail with the busy greeting, otherwise they hear a busy tone. A person on do not disturb is also skipped by ring groups (their phones count as busy).

Call forwarding

There are three forwards, each set and cleared on its own:

ForwardPhone codesTakes effect
Forward every call to*72 + number, *73At once: the person's phones do not ring at all
Forward when busy to*90 + number, *91When the person is busy or on do not disturb
Forward when not answered to*52 + number, *53After Ring for (seconds) with no answer

The target can be another extension or an outside number. Without a busy or no-answer forward, those calls go to voicemail. Set them from the phone, from the portal (Forward every call to, When I am busy, forward to, When I do not answer, forward to), in the console on the extension's Call handling card, or with onyx ext calls acme 101 --always 916125550199.

Good to know:

  • A chain of forwards stops after five steps, so two people forwarding to each other cannot loop forever; the caller hears a fast busy tone.
  • When an outside caller is forwarded to an outside number, the forwarded call shows the tenant's main number, not the original caller's number. Without a main number the caller's own number is passed on, which many carriers refuse.
  • Forwarded calls to outside numbers count against Call limits (toll fraud). If international calls are allowed only for some extensions, international forwards are refused, because a forwarded call has no calling extension.

To ring a desk phone and a mobile together, use Ring mobile too in a status profile (below). To try the desk first and the mobile after, set the mobile as the no-answer target of the status.

Status profiles

Everyone has a status: Available, Away, Lunch or Business trip, and Do not disturb on top of them. Each status can send calls somewhere else, so changing the status changes where calls go, without touching each forward.

For each status you can set:

SettingWhat it does
Ring for (s)How long the phones ring in this status; empty = the extension's Ring for (seconds)
Not answered: colleagues / outsideWhere an unanswered call goes, separately for calls from other extensions and from outside; empty = voicemail
Busy: colleagues / outsideWhere a call goes when the person is on a call, on do not disturb, or has no phone online; empty = voicemail (or a busy tone without voicemail)
Ring mobile tooThe Mobile number rings together with the desk phones; whichever answers first takes the call

Do not disturb never rings the phones, so only its two busy targets apply: for example, send outside callers to the receptionist and colleagues to voicemail.

Changing the status. From a phone: *31 Available, *32 Away, *33 Lunch, *34 Business trip, *30 switches between Away and Available. The phone says the new status (or beeps on a server without the speech package). Choosing a status also turns do not disturb off. In the portal the person picks it on the My status card; an administrator on the extension's Status card; from a shell onyx ext status acme 101 away.

Following office hours. Pick a business hours number under Follow office hours: the status becomes Available when it opens and the Status when closed (Away, Lunch or Business trip) when it closes. Only the moment of opening or closing changes it, and only from the status the schedule set, so someone who picked Business trip for the day stays on it. Holidays and a forced open or closed count too.

Good to know:

  • A forward set with *72, *90 or *52 (or in the call handling card) wins over the status profile.
  • Ringing a mobile is a call to an outside number: the same caller ID and Call limits (toll fraud) rules apply as to forwards. If the mobile's own voicemail answers before the desk phone, it takes the call; keep Ring for (s) shorter than the mobile's voicemail delay (often 20-25 seconds).
  • A ring group or queue rings the person's phones only; status profiles apply to calls to the person's own extension.
  • The switchboard and the company directory show the status, so colleagues see who is away.

Voicemail

Every extension has a voicemail box unless Voicemail is turned off on it. Its PIN is set when the extension is created and shown in the console (Voicemail PIN).

Listening to messages

  • Dial *97, or dial your own extension number, and enter your PIN. The spoken menu offers new and saved messages and the mailbox options.
  • Dial *98 from any phone to reach any box: enter the box number, then its PIN.
  • In the user portal, play and delete messages in the browser; see The user portal.
  • By e-mail, if the extension has an E-mail and the server can send mail (below).

Phones show a message waiting light while there are new messages.

What callers hear

A call rings the person's phones for Ring for (seconds), then goes to voicemail with the "unavailable" greeting. A busy line or do not disturb goes to voicemail with the "busy" greeting. Callers can listen to their message before saving it. A message can be up to 5 minutes long and must be at least 2 seconds; a box holds up to 100 messages.

When voicemail is off, an unanswered caller hears that nobody is available, and a caller to a busy line hears a busy tone.

Greetings, name and PIN

People record their unavailable and busy greetings and their name from the mailbox options in the *97 menu; greetings can be up to 2 minutes. Recording greetings in the portal is not available yet.

Change the PIN in the console (Voicemail PIN on the extension) or with onyx ext set acme 101 --pin 482913.

Voicemail to e-mail

New messages are e-mailed as a WAV attachment to the extension's E-mail, with the subject "New voicemail from" the caller and the length. The message also stays in the mailbox.

The server needs a mail server to send through. On Server settings, fill in the E-mail (SMTP) form and click Save:

SettingWhat to enter
Mail serverYour SMTP relay, for example smtp.example.com
EncryptionSTARTTLS (default; ports 587 and 25), TLS from the start (port 465) or None
PortEmpty means 587, or 465 with TLS from the start. Changing Encryption moves 25 or 587 to 465 and back.
Username and PasswordIf the relay needs a sign-in. An empty Password keeps the one saved.
Mail senderThe From address, for example [email protected]. Empty means the Username when it is an e-mail address; otherwise each message's own sender, which most mail servers refuse.

The form points out settings that cannot work together while you type, such as TLS from the start on port 25. Then type your address under Send a test to and click Send test e-mail: it saves the form first and sends through it. If the test fails, the reason stays under the button, in one sentence with what to change (for example "mail.example.com:25 does not start with TLS" or the mail server's own refusal). Many relays only accept a sender address of their own domain; set Mail sender to one. All settings are listed in Server settings reference.

Missed-call e-mail

Tick E-mail each missed call on the extension (or, as the person, E-mail me each missed call in the portal's My calls card) to get an e-mail for every call to the extension nobody answered: who called, when, and whether the person was busy or did not answer. It needs the extension's e-mail address and the server's mail settings (the same as voicemail to e-mail). Calls to ring groups and queues are not counted, only calls to the person's own extension. From the command line: onyx ext set acme 101 --missed-email on.

Voicemail as a destination

Wherever the console asks where a call goes (a phone number, a menu option, a ring group's "if nobody answers"), you can choose Voicemail of 101. The caller goes straight to that box and hears its unavailable greeting. Only boxes with voicemail on are offered.

Ring groups

A ring group is one number that rings several people.

  1. On Extensions & numbers, click Add and choose Ring group. The form suggests a number from 600.
  2. Enter the Name, for example Sales.
  3. How it rings: Ring everyone at once, or Ring one after another, in order.
  4. Members: extensions, or outside numbers written as your users dial them (for example 916125550199), separated by commas. Up to 50.
  5. Ring time (everyone at once): how long all members ring together, in seconds.
  6. Ring time per person (in turn): how long each member rings when they ring in turn.
  7. Name prefix: put in front of the caller's name, for example Sales: , so members know which group was called.
  8. If nobody answers: where the call goes next, for example a voicemail box or another number.
  9. Click Create ring group.

Members that are extensions ring their phones only: their own voicemail, forwarding and no-answer settings do not apply inside a group, and a member on do not disturb is skipped. Members cannot be other ring groups, queues or menus. A short number that is not an extension (four digits or fewer) is refused as a likely typo.

To change a ring group, open it, edit the Settings card and click Save; calls use the change right away. For agents who log in and out, waiting music and announcements, use a call queue instead (Call centre).

Paging and intercom

Paging groups

A paging group makes several phones answer on speaker at once, for announcements.

  1. Click Add on Extensions & numbers and choose Paging group (suggested from 400).
  2. Enter the Name and the Phones to page: extensions, separated by commas (up to 100).
  3. Tick Two-way (people paged can talk back) if they should be able to answer; otherwise it is announcement only.
  4. Click Create paging group.

Dialling the group's number opens the speaker of every desk phone of those extensions. Phones already on a call are skipped, forwarding is ignored, and browser softphones are not paged. To change the members, delete the paging group and create it again.

Intercom

*80 followed by an extension calls that person's desk phones and asks them to answer on speaker at once, for example *80102. It rings for up to 20 seconds; browser softphones are not called.

Paging and intercom send the auto-answer request that Yealink, Grandstream, Poly and Cisco phones understand. Whether a phone really answers by itself also depends on the phone's own intercom setting; if it just rings, look for "auto answer" or "allow intercom" in the phone.

Call parking

Parking puts a call on hold where anyone in the company can pick it up.

  1. During the call, press the phone's Park button, or transfer the call to 700 with the transfer key (##700 on a phone without one). To park it in a particular slot, press that slot's Park slot key, or transfer the call to the slot number (for example 705).
  2. The engine parks it in the first free slot from 701 to 720 (or in the slot you chose; if that one is taken, in the first free one).
  3. The phone that parked the call gets a text message: "Parked on 701: Jane Smith 6125551234. Dial 701 to pick it up."
  4. Anyone dials that slot number, or presses its lit Park slot key, to pick the call up. Simpler still: press the lit Park button, or dial 700, on an idle phone. That picks up the parked call (with several parked, the one in the lowest slot).

A parked call is never simply dropped. If nobody picks it up within 120 seconds:

  1. It rings the person who parked it back, on all their phones (on a hot desk, whoever is logged in there), for 30 seconds. Their phone shows Park 701: before the caller's name, so they know it is a parked call coming back. The caller keeps hearing hold music.
  2. If they do not answer, it goes where If they do not answer says on the Call parking page: for example the receptionist or a ring group. Unless you choose something, it goes to the voicemail of the person who parked it (and ends if they have no voicemail).

Parked callers hear the tenant's hold music (see Hold music).

To see which slot a call went to: read the text message on the phone that parked it, look at the Park slot keys (they light while a call is parked in that slot), open Call parking in the console, or use the switchboard in the portal, which shows parked calls; see Conference rooms and the switchboard.

Whether a phone shows the text message depends on the phone: most desk phones show it as a message on the screen. Turn it off with Text the slot to the phone that parked the call on the Call parking page.

A Park slot key pressed during a call transfers the call to that slot. Set the phone to transfer blind on these keys (most do by default): with an attended transfer, the phone calls the slot first and finds nobody there.

The Call parking page

Call parking in the console menu shows and manages the tenant's parking:

  • Parked now lists every parked call with its slot, the caller, who parked it and how long it has waited, refreshed every few seconds. Send to… rings an extension or any number with the call; Hang up ends it.
  • Parking lot sets the Park number, the First slot and Last slot (up to 100 slots), Wait before ringing back (seconds) (15 to 3600), Ring the person who parked it (seconds) (0 to 300; 0 goes straight to the next step), If they do not answer (any destination; empty = the voicemail of the person who parked it), and Text the slot to the phone that parked the call. None of the numbers may be in use by an extension, group, queue, menu or conference room. After moving the slots, change the Park slot keys on the phones too: they keep watching the old numbers.
  • Desk phones shows which phones have a Park button and park slot keys. Add Park buttons gives one to every phone that can have one and has none yet, after its other keys; phones that are online get it at once.

The Park button

A Park button is a phone key that parks the current call with one press. Add one to a phone on Desk phones > Keys (key type Park button, no number needed), or to all phones at once from Call parking. It always uses the tenant's park number, so changing the park number updates the buttons too.

PhoneHow the Park button works
Grandstream GRP and GXPThe phone's Call Park key. On a GXP1628/1630 it is one of the eight multi-purpose keys: the phone uses its line keys for calls and takes them over during a call
YealinkThe phone's Call Park key, in transfer mode
Poly VVX and Edge EA key that transfers the active call to the park number
Mitel 6800 and 6900The phone's Park key, set up for Asterisk
Snom DA transfer key to the park number
Htek UC9The phone's Call Park key

Cisco, Fanvil, CyberData and DECT handsets do not get a Park button yet, nor do phones whose keys are all the person's line (a Grandstream GXP1610 to GXP1625, a Yealink T31): transfer the call to the park number instead, and dial it from the idle phone to pick the call up again.

Call pickup

  • *8 answers any phone of the tenant that is ringing right now.
  • ** followed by an extension answers that extension's ringing call, for example **102. An Extension (BLF) key for 102 shows when it rings.

Call recording

Calls are recorded when any of these is on:

WhereSettingWhat is recorded
ExtensionRecord calls: Every callCalls to that person's extension, and the calls they make to other extensions and outside numbers
ExtensionRecord calls: Calls with outside numbers onlyCalls to that person from outside, and the calls they make to outside numbers; calls between colleagues are not recorded
Phone number (DID)Record every call to this numberCalls to that number, when they ring an extension directly or are passed on to an outside number
Call queueRecord calls answered from this queueCalls answered through that queue
Ring groupRecord the calls this group connectsCalls answered by any member of the ring group
Conference roomRecord conferences in this roomThe whole conference, one file

Calls that reach someone as a member of a ring group or a queue are not recorded by that person's own setting or by the phone number's setting. Queue and ring group calls are recorded by the group's own switch. See Call recordings.

Recording a call from the phone. During a call, press *1 to start recording it; the phone beeps. Press *1 again to stop (a lower tone). If the call is already recorded by a setting, two beeps say so and it keeps recording. The recording is listed with the call like any other. An administrator can take this away from a person: untick May record a call from the phone on the extension. The Record button in the portal softphone does the same for calls in the browser.

A call is recorded once, however many times it is transferred. Recordings are found, played, downloaded, held and deleted on Recordings, which also sets how long they are kept; see Call recordings.

Recording notice. Where the law requires callers to be told, turn on Play a recording notice to outside callers on the Recordings page. Every outside call to the company's phone numbers then starts with "This call may be recorded" (in the server's own voice, made with the speech package) or with a prompt of your own chosen there. The call is answered to play it, so the caller's carrier counts it as connected from that moment. From the command line: onyx tenant set acme --record-notice on.

Fax

A fax box is a number that answers fax calls. Each fax it receives is e-mailed as a PDF, and a PDF can be sent as a fax from it.

  1. On Extensions & numbers, click Add and choose Fax box (the form suggests a number from 880).
  2. Enter the Name, the address under E-mail faxes to (several, separated by commas) and, optionally, the Fax header name printed at the top of faxes you send.
  3. On Inbound routes, route your fax number to the fax box, like any other number.

Received faxes arrive by e-mail with the PDF attached (the server's mail settings, as for voicemail to e-mail) and are listed on the fax box's page under Faxes, with Open for each one. A fax that could not be received completely is reported by e-mail too, so the sender can be asked again.

To send a fax, open the fax box, type the number under Send to as a phone would dial it (with the outside line prefix, if your outbound routes use one), choose the PDF and click Send fax. Pages are sent at fine resolution on letter-sized paper. The result (pages sent, or why it failed) is e-mailed to the fax box's address and shown in the list.

Good to know:

  • Fax over the internet is fragile: it works best with a carrier that supports T.38 or a clean G.711 (u-law) path, and no other codec on the trunk. If faxes fail part way, ask the carrier about T.38.
  • Fax calls follow the same outbound routes, caller ID and Call limits (toll fraud) as other outside calls.
  • From the command line: onyx fax add acme 880 --name "Office fax" --email [email protected] --station "ACME DENTAL" and onyx fax list acme.

Hot desking

A hot desk is a shared phone. Anyone logs in to it and, until they log out, it calls and rings as them.

To make a phone a hot desk, click Make hot desk next to it in the extension's Phones card, or Make it a hot desk on Desk phones. The phone keeps its own extension (for example a "Desk 3" extension) for when nobody is logged in. Browser softphones cannot be hot desks.

To log in, dial *55 on the desk phone, enter your extension and press #, then enter your voicemail PIN. Three wrong PINs end the call. From then on the desk:

  • calls with your name, number and outbound caller ID, and records your calls if your extension records;
  • rings for calls to your extension, together with your other phones, and no longer rings for the desk's own extension;
  • opens your voicemail with *97, logs you in to your queues with *45, and gives you supervisor codes if you have them;
  • keeps its own emergency caller ID, because that number says where the phone is.

Dial *56 to log out. Logging in at another desk moves you there, and someone else logging in at your desk logs you out. Desk phones set up by Desk phones re-read their settings so their screen shows who is logged in.

Logging in by phone needs a voicemail box: a person with voicemail off cannot use *55. An administrator can log anyone in or out on Desk phones with Log in… and Log out. onyx hotdesk list shows who is logged in where.

Phone keys (BLF) and presence

Desk phones set up by Onyx Voice can carry programmable keys. On Desk phones, click Keys next to a phone, then Add a key for each:

Key typeValueWhat it does
Extension (BLF)An extension, for example 102Lights while that person is on the phone or ringing; press to call them
Speed dialAny numberDials it
Park slotA slot, for example 701Lights while a call is parked there; press to pick it up
Park buttonNone (uses the park number)Parks the current call; see The Park button

Click Save keys; a phone that is online gets them at once. The first two keys are always the person's line (Line 1 and Line 2).

An Extension (BLF) key can also watch feature states:

  • *76102 lights while 102 is on do not disturb. It only shows the state; 102 switches it with *76.
  • *30102 lights while 102's status is not Available. On 102's own phone, a key *30 (speed dial) next to it switches Away and Available.
  • *27500 lights while business hours 500 is forced closed, and *28500 while it is forced open. Pressing these keys switches the override, which makes them handy on a receptionist's phone.

Presence of everyone in the company, with drag-and-drop transfer, is in the portal switchboard for operators; see Conference rooms and the switchboard. More on keys per phone model in Desk phones.

Hold music

Callers on hold, parked, waiting in a queue or waiting in a conference room hear the tenant's hold music: the standard music that comes with Onyx Voice, or music you uploaded. Uploading and choosing music is in Hold music.

Transfers

Desk phones and softphones transfer calls with their own transfer key, blind or attended. On a phone without one, dial ## and the number during the call for a blind transfer, or *2 and the number for an attended transfer (you talk to the other person first, then hang up to complete it).

Echo test and speaking clock

  • *43 answers, plays a short instruction and then repeats everything you say. Use it to check a phone's audio and delay without calling anyone.
  • *60 reads the date and time in the tenant's time zone.