API Message Guide

AI - Add Incoming Call Route

Layer Management
Direction To CallGem
Type of Service CG
Interface ID MA
Message Purpose This message is sent by the control application to CallGem to provision a tenant
Example AI\IDSupportMail\DNsupport@sytelco.com\GASupport Mailbox
Explanation The control application is adding an incoming call route that routes all sessions with destination address support@sytelco.com to a queue named Support Mailbox.
Notes From V10.6.577, GA0 indicates 'Route External with recording'; GA# indicates 'Route External without recording'
Parameters
Code Name Type Mandatory? Min Val Max Val Description
DN DialedNumber string false 0 80 Dialed number parameter
GA GroupAddress string false 1 80 Note in the context of the AddIncomingCallRoute (AI) message this may be any address. If omitted the route is treated as a landlord route.
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.
YI Identity string true 0 80 The identity of the route. The identity parameter is used to uniquely identify the route.