API Message Reference

GM - Group Membership

Layer Agent
Direction To CallGem
Type of Service CG
Interface ID AG
Message Purpose This message registers or de-registers an agent with a group or an abstract group.
Example GM\CNsystem\ANReception\GA200\ON\GO999
Explanation The agent with Agent Identifier 'Reception' on the system campaign has been registered to queue address 200, with Order(priority) 999.
Notes
  • An agent may belong to multiple groups. Resource contention is handled by the queues having relative priorities, each group being processed in sequence.
  • Group membership is immediate, upon successful parse.
  • On agent logout all group memberships cease.

Related Links: Group Membership [GM] - Campaign to CallGem

Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string false 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
CN CampaignName string false 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
FE ForceEndpoint boolean false 0 0 From V10.7.930 - If present, forces the GM parameter to be treated as an endpoint rather than a group (useful if a WA message has not yet been sent for the endpoint).
GA GroupAddress string true 1 80 Must be a valid group address specified in Softdial Repository.
This parameter is alphanumeric.
GM GroupMember string false 1 80 From V10.7.86 - The group member. This may be an agent endpoint or a group.
GO GroupOrder int false 0 9999 Group Order parameter. Queue membership is ordered by priority.
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