API Message Reference

ET - Enumerate Telephony

Layer Management
Direction To CallGem
Type of Service CG
Interface ID MA
Message Purpose This message requests CallGem to send TE messages to the host application for the specified events.
Example ET\TXABSales1\CI\LC\CD
Explanation TE messages will be generated for all Call Initiate [CI], Line Connected [LC] and Call Disconnect [CD] events.
Notes Registering for LC will also produce IC message notification for inbound calls.

See Telephony Message [TE] message.

For on overview of the query process, see Resource Enumeration API

From V10.6.263 there is a change to Enumeration behaviour when using the PersistToken (PS) parameter - see Resource Enumeration API.

Parameters
Code Name Type Mandatory? Min Val Max Val Description
AR AgentReady boolean false 0 0 From V10.7.1057 - If present, a TE message is returned for each telephony layer AR message.
CD CallDisconnect boolean false 0 0 If CD parameter is included, a TE message is returned for each CD event.
CI CallInitiate boolean false 0 0 If CI parameter is included, a TE message is returned for each CI event.
CS RateControl string false 1 1000000 From V10.6.660 - The number of event messages per second that the subscriber can handle during rollforward after re-subscribing. Defaults to 100 (per PersistToken). See Resource Enumeration API.
CT CallTransfer boolean false 0 0 If CT parameter is included, a TE message is returned for each CT event.
HA HoldAdvise boolean false 0 0 From V10.7.66 - If present, a TE message is returned for each HA event delivered to an agent.
IC IdentifyCTI string false 1 80 It indicates to which telephony layer (switch) the results relate.
LC LineConnect boolean false 0 0 If LC parameter is included, a TE message is returned for each LC event.
LK ListenAcknowledge boolean false 0 0 From V10.7.66 - If present, a TE message is returned for each LK event delivered to an agent.
MK MuteAcknowledge boolean false 0 0 From V10.7.66 - If present, a TE message is returned for each MK event delivered to an agent.
ND NowDisconnected boolean false 0 0 If ND parameter is included, a TE message is returned for each ND event.
PS PersistToken string false 1 80 Persist token. This tells CallGem to persist this transaction even if the socket connection from the originator fails. The transaction will buffer events in anticipation of reconnect and re-issue of the transaction.
TA TransferAcknowledge boolean false 0 0 From V10.7.66 - If present, a TE message is returned for each TA event delivered to an agent.
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 requests. Must be unique across all requests.

 

Copyright © 2004 - 2019  Sytel Limited