TO - Trunks Open

Layer

CTI

Direction

To CallGem

Type of Service

Interface ID

Message Purpose

This message tells CallGem what telephony resources are available to it.

Example

TO\NT50\ND\SD\PF

Explanation

The host is advising CallGem that the number of trunks currently available for outbound dialing is 50 and specifies that all three resource notifications will be used.

Notes

This message must be sent for each switch before any campaigns that will use that switch are opened. This is to advise CallGem how many trunks/ ports are available. It must then be resent whenever a change is made.

Some switches which don't have a "make predictive call" facility may also need to assign physical ports from which to dial, before transferring calls to agents. The number of ports available for this, together with any changes during a campaign must be notified to CallGem in the Dialing Ports (DP) parameter. For integrators and/ or users who need to work with this parameter, please contact your local Sytel representative for advice on how to provide for sufficient such ports in your planning.

You can use multiple switches with CallGem, and assign one switch to each campaign (using the Identify CTI (IC) parameter of the Open Campaign [OC] message).

Two Uses for Trunks Open [TO]

There are two uses for the Trunks Open [TO] message:

1. Optionally with an Identify CTI (IC) parameter, but without Campaign Name (CN) or Tenant Descriptor (TD) parameters. Used to inform CallGem of: the existence of a switch how many trunks/ports it has available what resource notifications it will provide If the Identify CTI (IC) parameter is absent the switch identifier is assumed to be '__singlecti'.
Message example	Description
TO\NT5	Defines switch '__singlecti ' as having 5 trunks and unlimited dialing ports
TO\IClittleswitch\NT4\DP3	Defines switch 'littleswitch' as having 4 trunks and 3 dialing ports
2. Optionally with an Identify CTI (IC) parameter, and with Campaign Name (CN) and/or Tenant Descriptor (TD) parameter(s). Used to set quotas or limits on the usage of trunks and/or ports by specific campaigns and/or tenants. It is not possible to open a campaign using a switch if this is the only type of Trunks Open [TO] message used so far, as it is not possible to set resource notification options with this form, nor does this actually define a switch as being available.
Message example	Description
TO\TDBigCorp\NT2000	Specifies that tenant 'BigCorp' is limited to 2000 trunks across all of their campaigns and all switches but can use all dialing ports available.
TO\TDTinyCorp\IClittleswitch\NT2\DP2	Specifies that tenant 'TinyCorp' is limited to 2 of the trunks and 2 of the dialing ports of switch 'littleswitch'. This does not limit them to that switch, however; it merely limits their usage on that particular switch.
Illegal Commands
Message example	Description
TO\NT5\ICtheswitch\TDthetenant\ND	Cannot set switch options and quotas at the same time
TO\NT5\ICtheswitch\TDthetenant (followed by) OC\CNthecampaign\ICtheswitch	Have set a quota, but not yet defined 'theswitch'. This would generate an Error 603 (IC parameter invalid)

Parameters
Code	Name	Type	Mandatory?	Min Val	Max Val	Description
CN	CampaignName	string	false	1	80	Used to set campaign-specific quotas.
CS	CallsPerSecond	int	false	1	9999999	The number of calls per second that this trunk interface can support. Switch (and carrier) throughput limits are often quoted as BHCA (busy hour call attempts).If there is a need to throttle the call launch rate, the BHCA value should be divided by 3600 and rounded up. If this parameter is not specified CallGem will assume a limit of 9999999 calls per second.
DH	DisconnectHint	boolean	false	0	0	If the DH parameter is specified, CallGem will send Disconnect Hint [DH] messages to the telephony layer, so that the telephony layer gets real-time notification of when it should drop calls.
DP	DialingPorts	int	false	0	999999	The number of dialing ports is the number of channels on which it is possible to have a dialing/ ringing outbound call simultaneously. If this parameter is not present CallGem will assume that the number of dialing ports is equal to the number of network-facing trunk channels specified in the NT parameter.
IC	IdentifyCTI	string	false	1	80	Used to give each telephony layer a unique identifier. See Multiple Switches
MT	MediaType	string	false	0	80	The type of media processed through this layer. If not specified this defaults to 'Voice'.
ND	NowDisconnected	boolean	false	0	0	No value required. Pass if telephony layer is to support the Now Disconnected [ND] message. Note support for the ND message is mandatory in order to support inbound campaigns.
NT	NumberOfTrunks	int	true	0	999999	Sets the number of network-facing trunk channels available to CallGem. The number of network-facing channels is not the total number of trunk channels, but the maximum number of channels that can be open simultaneously for launching outbound calls and handling inbound calls.
NX	NodeName	string	false	1	80	Optional parameter which if present identifies the telephony layer within a cluster to be used. If the NX parameter is not present the behaviour will be as if there is only a single telephony node available. To set up a two node cluster called 'main' with 100 trunks available on each node, usage would be as follows: TO\ICmain\NXnode1\NT100\ND\SL TO\ICmain\NXnode2\NT100\ND\SL If the NX parameter is omitted, behaviour is as described below
NX	IdentifyNode	string	false	1	80	Used to give each telephony layer node a unique identifier.
PF	PortFree	boolean	false	0	0	No value required. Pass if telephony layer is to support the Port Free [PF] message.
SD	StationDisconnect	boolean	false	0	0	No value required. Pass if telephony layer is to support the Station Disconnect [SD] message.
SL	SwitchLogin	boolean	false	0	0	Pre-V10.7.1345 - Indicates that the telephony layer needs to service agent station login requests. From V10.7.1345 - the SL parameter is deprecated. All media layers must support Switch Login [SL]/ Login Status [LS] message interchange.
TD	TenantDescriptor	string	false	1	80	Used when setting tenant specific quotas. Note: not the same usage as in other messages. See Comment below. If you are planning to work with Multi-Tenancy, we recommend that you contact Sytel for advice.
TK	Token	string	false	1	80	Token parameter