API Message Reference

P1 - Tenant Parameters

Layer Management
Direction To CallGem
Type of Service CG
Interface ID MA
Message Purpose This message is sent by the control application to CallGem to set tenant parameters
Example P1\TDtenant1\NT100\NA40
Explanation The control application is setting the tenant paremeters such that tenant 1 is limited to using a maximum of 100 trunks and 40 agents.
Notes
Parameters
Code Name Type Mandatory? Min Val Max Val Description
CL CallingLineIdentity string false 1 80 The CLI to be presented when this number is dialed. Any value passed here must be a valid address terminating to your equipment.
CR CallRecording boolean false 0 0 This parameter enables blanket recording for the tenant.
DP DialingPorts int false 0 999999 The number of lines upon which dials can be in progress simultaneously. If this parameter is not specified the number of dialing ports is assumed to be equivalent to the number of trunks.
LF DefaultLFO string false 1 80 Formerly DF, prior to V10.7.846 - The default address that calls should overflow to if no queue specific overflow address is specified.
LL Locale int false 0 999 The locale code for the tenant. The locale code determines which country's legislative program governs dialing limits.
NA NumberAgents int false 1 32768 Number of Agents parameter
NM NoMoveOnCallback boolean false 0 0 From V10.7.846 - If present, prevents agents being moved between campaigns for callbacks.
NT NumberOfTrunks int true 0 999999 Sets the number of network-facing trunk lines available to CallGem
PM PlayMessage string false 1 80 This parameter is alphanumeric and may contain parameter data which is a symbolic name relating to the sound fragment. The symbolic name is validated against what is in Softdial RepositorySounds.

The parameter data may be omitted. In the case where the data is omitted the sound played will be the default 'call completion' sound referenced in Softdial RepositorySounds.

RI RingTimeout int false 12 600 Value range is from 15 to 22 seconds.

This parameter determines the default RNA timeout for the tenant for predictive voice.

See Ring Timeout Management for detailed comments.

TD TenantDescriptor string true 1 80 Mandatory when operating in Multi-Tenancy. Otherwise it must not be used.

This parameter is alphanumeric and identifies to which tenant this message applies. Typically contains a company name.

TK Token string false 1 80 Token parameter
TV TimeoutValue int false 1 3600 The number of seconds that CallGem will wait before forcing closure of a campaign on this tenant.
TZ TimeZone string false 1 80 From V10.7.846 - This parameter may be in numeric and/or alpha form and will be used to report results by time zones.
ZT DSTEnabled boolean false 0 0 From V10.7.846 - If present, indicates that DST rules apply for the tenant's time zone.

 

Copyright © 2004 - 2019  Sytel Limited