API Message Guide

MR - Manage Route

Layer Management
Direction To CallGem
Type of Service CG
Interface ID MA
Message Purpose This message indicates to CallGem that the connected socket wants to route eligible inbound calls into queues on that campaign.
Example MR\TDdefault\CNCustCare
Explanation Eligible inbound calls will be routed to group address 200 on the CustCare campaign.
Notes An application can register to manage routing for a campaign, a single queue or globally. If the GA and CN parameters are omitted, CallGem will send Route Request [RQ] messages.
Last Changed Pre V9.2
Parameters
Code Name Type Mandatory? Min Val Max Val Description
CN CampaignName string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
GA GroupAddress string false 1 80 This must be a valid group address specified in the Softdial Name Space.

This parameter is alphanumeric.

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
TX TransactionIdentifier string true 1 87 Used by subsequent messages from CallGem to identify the corresponding request. Must be unique across all requests.