API Message Reference

CL - Close All

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 close all campaigns for a given tenant
Example CL\TDtenant1\TV200
Explanation The control application is requesting that CallGem close all campaigns currently open for Tenant1 in 200 seconds.
Notes Produces TenantData [Z1] responses from CallGem. If an agent is in any state other than 'logged in and working' at the time the request is made, he will not be included in the subsequent TenantData [Z1] message set.

For on overview of the query process, see Resource Enumeration API

Last Changed 9.3.0.9
Parameters
Code Name Type Mandatory? Min Val Max Val Description
TD TenantDescriptor string true 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.
TV TimeoutValue int false 1 3600 The number of seconds to wait before killing an open campaign. If not specified a default value of 3600 (or 1 hour) is asserted.

 

Copyright © 2004 - 2019  Sytel Limited