API Message Reference

NP - Number Priority

Layer Campaign
Direction To CallGem
Type of Service CG
Interface ID CA
Message Purpose This message changes the priority of a number in CallGem's predictive queue.
Example NP\CNCustCare\TN01992783287\CP10
Explanation The agent application is asking CallGem to change the priority setting for the telephone number 01992783287 to 10.
Notes This message will only ever be used for numbers in the predictive (i.e. non-timed) queue. See Number Management for a description of CallGem's other (timed) queues.

This message may be sent at any time.

Last Changed Pre V9.2
Parameters
Code Name Type Mandatory? Min Val Max Val Description
CN CampaignName string 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
CP CallPriority int false 0 2147483647 This parameter may have a value anywhere between 0 and 2147483647.

If this parameter is not present, the default is zero.

SI SessionIdentifier string false 1 120 Either the TN or the SI parameter must be used to identify the called party.

Used to give each called party a unique key. If omitted, CallGem assumes this parameter to be the same as the TN parameter. See Session Identifiers.

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
TN TelephoneNumber string false 0 80 Either the TN or the SI parameter must be used to identify the called party. See Session Identifiers.

 

Copyright © 2004 - 2019  Sytel Limited