API Message Reference

CA - Campaign Assignment

Layer CTI
Direction From CallGem
Type of Service CG
Interface ID CT
Message Purpose For inbound campaigns, and inbound call is assigned to a campaign based on route information. This message notifies the telephony layer of the route assignment.
Example CA\TDDemo\CNInbound Renewals\SIinbound_1234
Explanation CallGem is advising the telephony layer that the session identified as inbound_1234 is routed to a queue that belongs to campaign Inbound Renewals on tenant Demo.
Notes
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 / \ : * ? " < > | & % + ! ' ;
SI SessionIdentifier string false 1 120 Session Identifier parameter
TD TenantDescriptor string false 1 80 Mandatory with V10 or with previous versions 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.
YS SessionUUID string false 20 50 From V10.7.596 - Each media session has a universally unique identifier assigned on creation. The UUID can be used by telephony layer messaging as an alternative unique form of reference to the SI parameter.

 

Copyright © 2004 - 2019  Sytel Limited