[Index]

Model: device/msteamsonline/CsCallQueue

Call Queues

Full HTML Help

Overview

Microsoft Teams call queues allow you to manage incoming callers as they arrive in a call queue, and for the duration of their wait in the call queue, until they're connected to an agent. For example, you can set up a call queue to play a greeting message as a caller arrives in the queue, or play a music file while they're waiting to route to a call agent.

Note

Call queues support the following audio file types: .MP3, .WAV, .WMA

You can set up a call queue to efficiently route callers out of the queue, to the first available agent, for example. Although it is possible to assign an entire team of users as a member of a call queue via the MS Teams portal, the functionality to set this up from within VOSS Automate is reserved for future development. However, if you've set this up on the MS Teams portal, VOSS Automate will allow you to sync in the configuration.

Note

Visit the Microsoft documentation for more information around the recommended call queue configuration, including some options that you can set up in VOSS Automate (https://docs.microsoft.com/en-US/microsoftteams/create-a-phone-system-call-queue).

At the time of writing (VOSS Automate 21.4), Microsoft's recommended settings for call queue are as follows:

Changes you make to call queues from within VOSS Automate updates call queues in the Microsoft cloud portal, and changes made in the Microsoft cloud also syncs to the relevant call queues in VOSS Automate.

View and Manage Microsoft Teams Call Queues

This procedure displays, edits, and deletes existing Microsoft Teams call queues, and adds new call queues, from within VOSS Automate.

  1. In the VOSS Automate Admin portal, go to (default menus) Subscriber Management > Call Queues to open the Call Queues summary list view.

  2. View existing call queues, which may have been added either from VOSS Automate or from the Microsoft cloud portal.

    Note

    From the list view you can choose to update, delete, move, or export existing call queues, or add new call queues, and your changes will sync to the call queue details in the Microsoft Teams cloud portal.

  3. Choose an option:

General Info Tab

This tab configures the call queue name, adds resource accounts and calling IDs (optionally), and allows you to choose the language that will be used for transcribing voicemail messages and to play system prompts.

Note

When resource accounts (resource users) are added to call queues and auto attendants, deleting a call queue or auto attendant triggers a system workflow that first disassociates any associated resource accounts, then deletes the call queue or auto attendant.

Greeting and Music Tab

This tab configures greeting and music on hold options.

The table describes the fields on this tab:

Field Description
Greeting > Options

Choose a greeting option, either of the following:

  • No greeting

  • Play an audio file

    Selecting this option displays the Audio file field, where you can choose the audio file you wish to use.

  • Add a greeting message

    Selecting this option displays the Message field, where you can fill out the greeting message to use.

    The typed message will be converted to an audio message by MS text-to-speech.

Greeting > Music on hold

Choose an option for playing music while the caller is on hold. Options are:

  • Play default music

  • Play an audio file

    Selecting this option displays the Audio file field, where you can choose the audio file you wish to use.

Note

Call Answering Tab

This tab defines how incoming calls in the call queue are answered. For example, from the Options drop-down list, you can choose to have a specific MS team and channel answer calls in the queue, or from the drop-down list choose to assign specific call agents, distribution lists and groups.

Assigning a MS team to call answering must be configured on the MS Teams portal and synced to VOSS Automate. The ability to set this up from within VOSS Automate is reserved for future development.

On this tab you can also enable (recommended) or disable conference mode, which reduces the time it takes for the caller to connect with an agent.

Note

Conference mode requires that the agent answering calls is using Microsoft Teams desktop client or a Microsoft phone.

Agent Selection Tab

This tab defines the agents available to answer calls, and how calls are distributed and routed to agents.

Routing Methods

The table describes routing methods for call queues:

Routing method Description
Attendant routing Rings all agents in the queue at the same time. The first agent to pick up the call takes the call.
Serial routing Rings call agents in the order they're listed in the call agents list. The call cycles through agents until one answers the call.
Round robin A recommended routing method. A balanced routing approach that sends the same number of calls from the queue to each agent.
Longest idle

A recommended routing method. Routes the next call to the agent who has been idle the longest. An agent is considered idle when their presence status is set to Available. Calls won't be routed to agents with their presence status set to Unavailable.

Presence-based routing cannot be enabled for this routing method.

Agent selection configuration

The table describes additional configuration options on the Agent Selection tab for call queues:

Presence-based routing

Recommendation is enabled. Disable to send calls to agents who choose to receive calls, regardless of their presence status. Enable to send calls only to agents with their presence status set to Available.

This option cannot be enabled if the routing method is set to Longest idle.

Call agents can opt out of taking calls Recommendation is enabled. Disable to ensure agents accept a call routed to them. Enable to allow agents to choose not to answer a call.
Call agent alert time The time, in seconds, to wait before redirecting the call to the next agent. The recommendation is a minimum of 20 seconds. The minimum alert time is 15 seconds, and the maximum alert time is 180 seconds.

Call Overflow Handling Tab

This tab defines the maximum number of calls that may be in the queue, and how the system handles calls that exceed the maximum.

Note

The default maximum number of incoming calls allowed in a call queue is 200 calls.

There are two options for incoming calls once the maximum number of calls is reached for the current call queue:

Call Timeout Handling Tab

This tab defines the maximum wait time (in seconds) that an incoming call can remain in the call queue. Once you've set up the maximum wait time, you can configure what happens to the call, that is, disconnect the call, or redirect it (and configure redirect options).

Note

The default maximum wait time is 2700 seconds (45 minutes). The call is dropped or redirected after the predefined wait time threshold is reached.

Model Details: device/msteamsonline/CsCallQueue

Title Description Details
General info Group Assigned by FDP
  • Field Name: General info
  • Type: Object
Name Go to https://docs.microsoft.com/en-US/microsoftteams/create-a-phone-system-call-queue for more information on Call Queue set up. The following settings are recommended by Microsoft: Conference mode to Auto. Routing method to Round robin or Longest idle. Presence-based routing to On. Agent alert time: to 20 seconds
  • Field Name: General info.Name
  • Type: String
Resource Accounts
  • Field Name: ApplicationInstances.[n]
  • Type: Array
1st Phone Number of 1st Resource Account
  • Field Name: General info.FirstApplicationInstanceFirstPhoneNumber
  • Type: String
Language This lets you set the language used to transcribe voicemail messages and play system prompts to the calle
  • Field Name: General info.LanguageId
  • Type: String
  • Target: device/msteamsonline/CsAutoAttendantSupportedLanguage
  • Target attr: DisplayName
  • Format: uri
Greeting and music Group Assigned by FDP
  • Field Name: Greeting and music
  • Type: Object
Greeting
  • Field Name: Greeting
  • Type: Object
Options
  • Field Name: Greeting and music.Greeting.Options
  • Type: String
  • Choices: ["No greeting", "Play an audio file", "Add a greeting message"]
Audio File
  • Field Name: Greeting and music.Greeting.WelcomeMusicFileName
  • Type: String
  • Format: db_filename
Message
  • Field Name: Greeting and music.Greeting.WelcomeTextToSpeechPrompt
  • Type: String
Music on hold
  • Field Name: MusicOnHold
  • Type: Object
Options
  • Field Name: Greeting and music.MusicOnHold.Options
  • Type: String
  • Choices: ["Play default music", "Play an audio file"]
Audio file
  • Field Name: Greeting and music.MusicOnHold.MusicOnHoldFileName
  • Type: String
  • Format: db_filename
Call answering Group Assigned by FDP
  • Field Name: Call answering
  • Type: Object
Call answering
  • Field Name: CallAnswering
  • Type: Object
Options
  • Field Name: Call answering.CallAnswering.Options
  • Type: String
  • Choices: ["Choose a team", "Choose users and groups"]
Channel Id
  • Field Name: Call answering.CallAnswering.ChannelId
  • Type: String
ChannelUserObjectId
  • Field Name: Call answering.CallAnswering.ChannelUserObjectId
  • Type: String
Team
  • Field Name: Call answering.CallAnswering.Team
  • Type: String
Channel
  • Field Name: Call answering.CallAnswering.Channel
  • Type: String
Call Agents
  • Field Name: Users.[n]
  • Type: Array
Number of Call Agents
  • Field Name: Call answering.CallAnswering.UsersCount
  • Type: Integer
Distribution Lists and Groups
  • Field Name: DistributionLists.[n]
  • Type: Array
Should Overwrite Callable Channel Property If the channel is in use by another Call Queue, set this setting to true to overwrite it.
  • Field Name: Call answering.CallAnswering.ShouldOverwriteCallableChannelProperty
  • Type: Boolean
Conference Mode Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. For conference mode to work, agents in the call queue must use the Microsoft Teams desktop client or a Microsoft Phone
  • Field Name: Call answering.ConferenceMode
  • Type: Boolean
Agent selection Group Assigned by FDP
  • Field Name: Agent selection
  • Type: Object
Routing Method ROUND ROBIN - balances the routing of incoming calls so that each call agent gets the same number of calls from the queue. LONGEST IDLE - routes each call to the agent who has been idle the longest time. ATTENDANT ROUTING - rings all agents in the queue at the same time. SERIAL ROUTING - rings all call agents one by one in the order specified in the Call Answering User list.
  • Field Name: Agent selection.RoutingMethod
  • Type: String
  • Choices: ["Attendant routing", "Serial routing", "Round robin", "Longest idle"]
Presence-based routing When turned off, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When turned on, opted-in agents will receive calls only when their presence state is Available.
  • Field Name: Agent selection.PresenceBasedRouting
  • Type: Boolean
Call agents can opt out of taking calls If you turn this off and a call agent gets a call, they must answer it. If you turn it on, each call agent can choose whether or not to answer an incoming call.
  • Field Name: Agent selection.AllowOptOut
  • Type: Boolean
Call agent alert time (seconds) Range - 15 to 180 seconds
  • Field Name: Agent selection.AgentAlertTime
  • Type: Integer
  • Minimum: 15
  • Maximum: 180
Call overflow handling Group Assigned by FDP
  • Field Name: Call overflow handling
  • Type: Object
Maximum calls in the queue Maximum calls = 200
  • Field Name: Call overflow handling.OverflowThreshold
  • Type: Integer
  • Maximum: 200
When the maximum number of calls is reached
  • Field Name: OverflowHandling
  • Type: Object
Options
  • Field Name: Call overflow handling.OverflowHandling.Options
  • Type: String
  • Choices: ["Disconnect", "Redirect this call to"]
Redirect this call to
  • Field Name: Redirect
  • Type: Object
Redirect to
  • Field Name: Call overflow handling.OverflowHandling.Redirect.RedirectTo
  • Type: String
  • Choices: ["Person in organization", "Voice app", "External phone number", "Voicemail (personal)", "Voicemail (shared)"]
Person in organization
  • Field Name: Call overflow handling.OverflowHandling.Redirect.Person
  • Type: String
  • Target: device/msteamsonline/CsOnlineUser
  • Target attr: Identity
  • Format: uri
Voice app
  • Field Name: Call overflow handling.OverflowHandling.Redirect.VoiceApp
  • Type: String
  • Target: device/msteamsonline/CsOnlineApplicationInstance
  • Target attr: UserPrincipalName
  • Format: uri
External phone number
  • Field Name: Call overflow handling.OverflowHandling.Redirect.Phone
  • Type: String
Voicemail (personal)
  • Field Name: Call overflow handling.OverflowHandling.Redirect.VoicemailPersonal
  • Type: String
Voicemail (shared)
  • Field Name: Call overflow handling.OverflowHandling.Redirect.VoicemailShared
  • Type: String
Transcription
  • Field Name: Call overflow handling.OverflowHandling.Redirect.EnableOverflowSharedVoicemailTranscription
  • Type: Boolean
Skip voicemail system message
  • Field Name: Call overflow handling.OverflowHandling.Redirect.VoicemailSharedSkipSystemMessage
  • Type: Boolean
Greeting
  • Field Name: VoicemailSharedGreeting
  • Type: Object
Options
  • Field Name: Call overflow handling.OverflowHandling.Redirect.VoicemailSharedGreeting.Options
  • Type: String
  • Choices: ["Play an audio file", "Add a greeting message"]
Audio File
  • Field Name: Call overflow handling.OverflowHandling.Redirect.VoicemailSharedGreeting.OverflowSharedVoicemailAudioFilePromptFileName
  • Type: String
  • Format: db_filename
Message
  • Field Name: Call overflow handling.OverflowHandling.Redirect.VoicemailSharedGreeting.OverflowSharedVoicemailTextToSpeechPrompt
  • Type: String
Call timeout handling Group Assigned by FDP
  • Field Name: Call timeout handling
  • Type: Object
Maximum wait time Maximum time 2700 secs (45 mins)
  • Field Name: Call timeout handling.TimeoutThreshold
  • Type: Integer
When call times out
  • Field Name: TimeoutHandling
  • Type: Object
Options
  • Field Name: Call timeout handling.TimeoutHandling.Options
  • Type: String
  • Choices: ["Disconnect", "Redirect this call to"]
Redirect this call to
  • Field Name: Redirect
  • Type: Object
Redirect to
  • Field Name: Call timeout handling.TimeoutHandling.Redirect.RedirectTo
  • Type: String
  • Choices: ["Person in organization", "Voice app", "External phone number", "Voicemail (personal)", "Voicemail (shared)"]
Person in organization
  • Field Name: Call timeout handling.TimeoutHandling.Redirect.Person
  • Type: String
  • Target: device/msteamsonline/CsOnlineUser
  • Target attr: Identity
  • Format: uri
Voice app
  • Field Name: Call timeout handling.TimeoutHandling.Redirect.VoiceApp
  • Type: String
  • Target: device/msteamsonline/CsOnlineApplicationInstance
  • Target attr: UserPrincipalName
  • Format: uri
External phone number
  • Field Name: Call timeout handling.TimeoutHandling.Redirect.Phone
  • Type: String
Voicemail (personal)
  • Field Name: Call timeout handling.TimeoutHandling.Redirect.VoicemailPersonal
  • Type: String
Voicemail (shared)
  • Field Name: Call timeout handling.TimeoutHandling.Redirect.VoicemailShared
  • Type: String
Transcription
  • Field Name: Call timeout handling.TimeoutHandling.Redirect.EnableTimeoutSharedVoicemailTranscription
  • Type: Boolean
Skip voicemail system message
  • Field Name: Call timeout handling.TimeoutHandling.Redirect.VoicemailSharedSkipSystemMessage
  • Type: Boolean
Greeting
  • Field Name: VoicemailSharedGreeting
  • Type: Object
Options
  • Field Name: Call timeout handling.TimeoutHandling.Redirect.VoicemailSharedGreeting.Options
  • Type: String
  • Choices: ["Play an audio file", "Add a greeting message"]
Audio File
  • Field Name: Call timeout handling.TimeoutHandling.Redirect.VoicemailSharedGreeting.TimeoutSharedVoicemailAudioFilePromptFileName
  • Type: String
  • Format: db_filename
Message
  • Field Name: Call timeout handling.TimeoutHandling.Redirect.VoicemailSharedGreeting.TimeoutSharedVoicemailTextToSpeechPrompt
  • Type: String