API Message Reference

D1 - Decommission Tenant

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 decommission a tenant
Example D1\TDtenant1
Explanation The control application is requesting that tenand id Tenant1 is decommissioned with normal priority.
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.
Last Changed 9.3.0.9
Parameters
Code Name Type Mandatory? Min Val Max Val Description
PR Priority int false 0 2

0 Follow normal closure process for campaigns on this tenant.
1 Follow normal closure process for campaigns on this tenant.
2 Kill all running campaigns for this tenant.

If this parameter is not present the default is zero.

TD TenantDescriptor string true 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.
TK Token string false 1 80 Token parameter

 

Copyright © 2004 - 2019  Sytel Limited