API Message Reference

OG - Group Out Of Service

Layer Campaign
Direction To CallGem
Type of Service CG
Interface ID CA
Message Purpose Put Queue Out Of Service
Example OG\TDtenant1\CNCustCare\GA200\PR0
Explanation The host application is asking CallGem to put tenant1 group address 200 on campaign CustCare out of service with normal priority.
Notes
Last Changed 10.0.0.12
Parameters
Code Name Type Mandatory? Min Val Max Val Description
CN CampaignName string 1 80 Mandatory if the call is predictive.
GA GroupAddress string true 1 80 Group address parameter
PR Priority int false 0 2
0 Put the group out of service with normal priority; process any existing calls in queue.
1 Put the group out of service quickly; any calls in queue to be overflowed.
2 Put the group out of service immediately; any calls in queue to be overflowed. Drop any calls dequeued to agents.

If this parameter is not present the default is zero.

TD TenantDescriptor string 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

 

Copyright © 2004 - 2019  Sytel Limited