API Message Reference

GM - Group Membership

Layer Campaign
Direction To CallGem
Type of Service CG
Interface ID CA
Message Purpose This message registers or de-registers an agent with a hunt group (queue). Queues are set up in Softdial RepositoryCampaigns & Queues. An agent may only belong to a group if that agent is logged into the system campaign.
Example GM\CNCustCare\AN2\GA200\ON
Explanation The agent with Agent Identifier number 2 on the CustCare campaign has been registered to the group address.
Notes
  • An agent may belong to more than one group. Resource contention is handled on a first-come-first-served basis.
  • Group membership is immediate, upon successful parse.
  • On agent logout all group memberships cease.

Related Links: Group Membership [GM]

Last Changed Pre V9.2
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
CN CampaignName string 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
GA GroupAddress string true 1 80 Must be a valid group address.

This parameter is alphanumeric.

ON OnOff boolean false 0 0 If specified, an agent will be added to the group. If it is not specified, the agent will be removed from the group.
TD TenantDescriptor string false 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