Reference:Administration/PBX/Objects/Waiting Queue: Difference between revisions

From innovaphone wiki
Jump to navigation Jump to search
(New page: The Waiting Queue PBX object represents a waiting loop in the innovaphone PBX. When a call is received on this object, an audio file stored on a HTTP server is played back. The following s...)
 
mNo edit summary
 
(14 intermediate revisions by 5 users not shown)
Line 1: Line 1:
The Waiting Queue PBX object represents a waiting loop in the innovaphone PBX. When a call is received on this object, an audio file stored on a HTTP server is played back. The following specifications are made in the Queue section:
The Waiting Queue PBX object is used to put calls sent to this object into a queue. While the call is in the queue, it may either remain in alerting state or it be connected with an announcement played. Two announcements can be configured played one after the other, the second is repeated. Calls which are in the queue can be sent to groups of operators configured for the queue. Calls are strictly sent in a first in first out manner to operators. The next call is sent only after the previous call is connected. Destinations can be configured, which can be dialed using DTMF while a call is in the queue and connected.


=== 1st Announcement ===
'''The Waiting Queue PBX object does not support DTMF tone detection. Only 'telehpone-event' (RFC-2833) or DTMF signaling (H.245 User Input Indication / SIP INFO(dtmf-relay)) are supported.'''
* '''URL:''' The path of the audio file to be played. If a second Announcement is defined, this file is played only once. The playing of the audio file is repeated as standard.<br>The URL can be specified in the following format:<br>''<nowiki>http://192.168.0.1/webdav/moh.$coder?coder=g729,g711a&repeat=true</nowiki>''<br>The specification of the wildcard ''.$coder?coder=g729,g711a'' in place of the file extension ''.g729'' enables several formats to be specified. They must be specified separated by a comma and must be available on the Web server. With the addition ''&repeat=false'', an automatic repeat can be disabled.
* '''External Name/No:''' Forwarding to an external user can take place alternatively.




=== 2nd Announcement ===
== Configuration ==
* '''URL:''' The path of the second audio file to be played. If a second URL is specified here, then it is played after the first Announcement URL. For the second Announcement, the playing of the audio file is likewise repeated as standard (see 1st Announcement).
* '''External Name/No:''' For the second Announcement, forwarding to an external user can likewise take place.


=== Addressing ===


* '''Max Call/Operator (%):''' By specifying a percentage value, calls that are forwarded to a call number or an operator (additional licences required) can be restricted.
The Long Name, Name Number and Node configuration parameters have the same meaning as for any other object.
* '''Alert:''' The music on hold or announcement is played after the time interval specified here has elapsed.
 
* '''Round Robin:''' Timeout before a switchover to the next subscriber.
=== Registration ===
* '''Primary:''' Time interval for the Primary Group.
 
* '''Primary Group:''' The Primary Group list box allows you to define which group should be the Primary Group, in so far as at least two groups were created for the Waiting Queue.<br>If a Primary Group is specified, the calls are signalled first to the subscribers of the Primary Group, and are also signalled to the subscribers of the other group after the Primary time interval has elapsed.
Hardware ID, PBX, Send Number, Password, Filter, Diversion Filter and Group Indications are used only for endpoints registered directly to the Waiting Queue object. This maybe useful to set diversions for the Waiting Queue object and such endpoints can be used to make calls and are treated as operators of the Waiting Queue.
* '''DTMF | Dest. No | Dest. Name:''' It is also possible to allow call forwarding using touch-tone dialling (DTMF).<br>DTMF = The DTMF character string (for example, 1 or *1#).<br>Dest. No = The destination number.<br>Dest. Name = The destination name.
 
=== CFNR Timeout ===
 
The timeout used for call forward no response. See Diversions.
 
=== Busy On ... Calls ===
 
This configuration parameter can be used to limit the calls in the queue. Calls connceted to a operator do not count in this respect anymore.
 
=== Announcements ===
 
For announcements the URL and/or Extern Name/no have to be configured. If no Extern Name/no is configured the local HTTP interface is used to retrieve the announcements. The URL has the following format:
 
<nowiki>http://<addr>/<filename.$coder>?coder=<coder-list>[&repeat=true|disc=true|random=true|record=true]</nowiki>
 
{|
|valign=top nowrap=true|'''addr'''
|The IP address of the web server. A DNS name cannot be used here.
|-
|valign=top nowrap=true|'''filename.$coder'''
|The filename of the announcement files including any path. $coder will be replaced by the actual coder used.
|-
|valign=top nowrap=true|'''coder-list'''
|A comma seperated list of all available coder. For each coder in the list the respective announcement file must be available on the server. The available coders are g729,g711a, g711u,g723.
|-
|valign=top nowrap=true|'''repeat=true'''
|If this is present the announcement will be repeated. If this is used for the 1st Announcement the 2nd Announcement will never be played.
<!--
|-
|valign=top nowrap=true|'''disc=true'''
|If this is present, the call will be disconnected as soon as the announcement URL is played (that is, when the source file
-- scheint nicht zu tun auch nicht, wenn man es in die zweite URL reintut
-->
|-
|valign=top nowrap=true|'''random=true'''
|If this is present, the announcement will be started at a random offset, so each caller will hear it from a different point in time.  This works with non-local URLs only though.
|}
 
Example
 
<nowiki>http://145.253.157.2/announce/welcome.$coder?coder=g711a,g711u,g729,g723</nowiki>
 
If no URL is configured the local HTTP interface plays the built-in music on hold by default.
 
If an Extern Name/No is configured then no local HTTP interface is used, but a call is sent to the configured Name/No. The URL is sent with this call as user-user-info, so that a remote HTTP interface can use it the same way as the local HTTP interface. As destination of the call any voip endpoint can be used.
 
1st announcement is played once when the call is connected. When 1st announcement is complete, the 2nd announcement is played repeatedly.  If there is no 2nd announcement, the caller will be disconnected when the 1st announcement has completed.
 
There are 2 pseudo URLs available, TONE and MOH.  Such URLs will be interpreted locally and connect to the systems tone and music-on-hold interface, respectively.
 
<nowiki>TONE</nowiki>
 
as URL will produce a constant tone (often recogonized as a dial-tone).  You can add a '''?tone=ringback''' which will give you a tone sequence with 1 second tone and 4 seconds silence (this is often recognized as a ring-back tone).
 
<nowiki>MOH</nowiki>
 
will produce the built-in music-on-hold. Please note that both TONE and MOH never end, so '''repeat=true''' is not required and '''disc=true''' will have no effect.
 
=== Max Call/Operator(%) ===
 
This configuration parameter allows to limit the number of current calls depending on the number of operator registrations in the primary group. Only the configured percentage of operator registrations are accepted as calls. Calls currently connected to operators do count in this context. For example if 2 operators are registered and the value is set to 150%, the 4th call received will get a busy. Note that only operators in the primary group count for this, this means if there is no primary group configured all calls are rejected with busy if any value is entered here.
 
=== Alert Timeout ===
 
The timeout (in seconds) after which the Waiting Queue connects incoming calls. If no timeout is configured the Waiting Queue will never connect. If a timeout of 0 is configured the Waiting Queue connects right away.
 
=== Round Robin Timeout ===
 
If a round robin timeout is configured the call is not sent to all members of the primary group at the same time, but it starts with one only. After the timeout the second is added, then the third and so on. The operator used for the first call changes in a round robin mannor.
 
=== Primary Group/Timeout ===
 
The call is sent to this group first, either to all members at the same time, or in a round robin mannor. After the configured Primary group Timeout expires the call is sent to all operators. Operators are all members of groups in which the Waiting Queue object itself is active member. The operators do not need to be active members of these groups.
 
=== Operator connect for SOAP ===
 
On the SOAP/TAPI interface a call to a waiting queue is normally indicated as connected as soon it is connected signalingwise, this means it is indicated as connected if an announcement is played. This behaviour can be changed so that it is indicated connected only after an operator has accepted the call by setting this checkmark.
 
=== Call busy Operators ===
 
Normally an operator who is already engaged in a Waiting Object call is not called again. If this checkmark is set, calls are delivered to these (busy) operators as well.
 
=== DTMF destinations ===
 
A list of DTMF destinations can be configured. Any DTMF digits dialed after the call is connected to an announcement is matched to this list. If a match is found the call is sent to Dest. No/Dest. Name. If no Dest. No/Dest. Name is configured more DTMF digits may be dialed for the final destination. If the destination of the call is not an endpoint, but a gateway (Trunk object, Gateway object), the call is sent only after a timeout of 4s after the last digit is dialed.
 
A '.' entered as DTMF destination means that any DTMF is treated as dialing information to another endpoint.
 
== Call Forwarding ==
 
Call Forwarding can be used with the Waiting Queue object and can be set/reset by endpoints registerd to the Waiting Queue object itself.
 
{|
|valign=top nowrap=true|'''CFU'''
|Executed as usual
|-
|valign=top nowrap=true|'''CFB'''
|Executed if the Busy on ... calls condition or the Max Call/Operator(%) condition applies.
|-
|valign=top nowrap=true|'''CFNR'''
|Executed if the CFNR timeout expires and no operator has accepted the call, even if the call is connected to an announcement.
|}
 
<!-- Keywords: waiting que -->

Latest revision as of 13:17, 4 January 2012

The Waiting Queue PBX object is used to put calls sent to this object into a queue. While the call is in the queue, it may either remain in alerting state or it be connected with an announcement played. Two announcements can be configured played one after the other, the second is repeated. Calls which are in the queue can be sent to groups of operators configured for the queue. Calls are strictly sent in a first in first out manner to operators. The next call is sent only after the previous call is connected. Destinations can be configured, which can be dialed using DTMF while a call is in the queue and connected.

The Waiting Queue PBX object does not support DTMF tone detection. Only 'telehpone-event' (RFC-2833) or DTMF signaling (H.245 User Input Indication / SIP INFO(dtmf-relay)) are supported.


Configuration

Addressing

The Long Name, Name Number and Node configuration parameters have the same meaning as for any other object.

Registration

Hardware ID, PBX, Send Number, Password, Filter, Diversion Filter and Group Indications are used only for endpoints registered directly to the Waiting Queue object. This maybe useful to set diversions for the Waiting Queue object and such endpoints can be used to make calls and are treated as operators of the Waiting Queue.

CFNR Timeout

The timeout used for call forward no response. See Diversions.

Busy On ... Calls

This configuration parameter can be used to limit the calls in the queue. Calls connceted to a operator do not count in this respect anymore.

Announcements

For announcements the URL and/or Extern Name/no have to be configured. If no Extern Name/no is configured the local HTTP interface is used to retrieve the announcements. The URL has the following format: 

http://<addr>/<filename.$coder>?coder=<coder-list>[&repeat=true|disc=true|random=true|record=true]
addr The IP address of the web server. A DNS name cannot be used here.
filename.$coder The filename of the announcement files including any path. $coder will be replaced by the actual coder used.
coder-list A comma seperated list of all available coder. For each coder in the list the respective announcement file must be available on the server. The available coders are g729,g711a, g711u,g723.
repeat=true If this is present the announcement will be repeated. If this is used for the 1st Announcement the 2nd Announcement will never be played.
random=true If this is present, the announcement will be started at a random offset, so each caller will hear it from a different point in time. This works with non-local URLs only though.

Example 

http://145.253.157.2/announce/welcome.$coder?coder=g711a,g711u,g729,g723

If no URL is configured the local HTTP interface plays the built-in music on hold by default.

If an Extern Name/No is configured then no local HTTP interface is used, but a call is sent to the configured Name/No. The URL is sent with this call as user-user-info, so that a remote HTTP interface can use it the same way as the local HTTP interface. As destination of the call any voip endpoint can be used.

1st announcement is played once when the call is connected. When 1st announcement is complete, the 2nd announcement is played repeatedly. If there is no 2nd announcement, the caller will be disconnected when the 1st announcement has completed.

There are 2 pseudo URLs available, TONE and MOH. Such URLs will be interpreted locally and connect to the systems tone and music-on-hold interface, respectively. 

TONE

as URL will produce a constant tone (often recogonized as a dial-tone). You can add a ?tone=ringback which will give you a tone sequence with 1 second tone and 4 seconds silence (this is often recognized as a ring-back tone). 

MOH

will produce the built-in music-on-hold. Please note that both TONE and MOH never end, so repeat=true is not required and disc=true will have no effect.

Max Call/Operator(%)

This configuration parameter allows to limit the number of current calls depending on the number of operator registrations in the primary group. Only the configured percentage of operator registrations are accepted as calls. Calls currently connected to operators do count in this context. For example if 2 operators are registered and the value is set to 150%, the 4th call received will get a busy. Note that only operators in the primary group count for this, this means if there is no primary group configured all calls are rejected with busy if any value is entered here.

Alert Timeout

The timeout (in seconds) after which the Waiting Queue connects incoming calls. If no timeout is configured the Waiting Queue will never connect. If a timeout of 0 is configured the Waiting Queue connects right away.

Round Robin Timeout

If a round robin timeout is configured the call is not sent to all members of the primary group at the same time, but it starts with one only. After the timeout the second is added, then the third and so on. The operator used for the first call changes in a round robin mannor.

Primary Group/Timeout

The call is sent to this group first, either to all members at the same time, or in a round robin mannor. After the configured Primary group Timeout expires the call is sent to all operators. Operators are all members of groups in which the Waiting Queue object itself is active member. The operators do not need to be active members of these groups.

Operator connect for SOAP

On the SOAP/TAPI interface a call to a waiting queue is normally indicated as connected as soon it is connected signalingwise, this means it is indicated as connected if an announcement is played. This behaviour can be changed so that it is indicated connected only after an operator has accepted the call by setting this checkmark.

Call busy Operators

Normally an operator who is already engaged in a Waiting Object call is not called again. If this checkmark is set, calls are delivered to these (busy) operators as well.

DTMF destinations

A list of DTMF destinations can be configured. Any DTMF digits dialed after the call is connected to an announcement is matched to this list. If a match is found the call is sent to Dest. No/Dest. Name. If no Dest. No/Dest. Name is configured more DTMF digits may be dialed for the final destination. If the destination of the call is not an endpoint, but a gateway (Trunk object, Gateway object), the call is sent only after a timeout of 4s after the last digit is dialed.

A '.' entered as DTMF destination means that any DTMF is treated as dialing information to another endpoint.

Call Forwarding

Call Forwarding can be used with the Waiting Queue object and can be set/reset by endpoints registerd to the Waiting Queue object itself.

CFU Executed as usual
CFB Executed if the Busy on ... calls condition or the Max Call/Operator(%) condition applies.
CFNR Executed if the CFNR timeout expires and no operator has accepted the call, even if the call is connected to an announcement.


Retrieved from "https://wiki.innovaphone.com/index.php?title=Reference:Administration/PBX/Objects/Waiting_Queue&oldid=23779"