Index

Classes


Class TelephonyContext

Class Summary
Constructor Attributes Constructor Name and Description
 
TelephonyContext(agtCommands)
Manager for the telephony contexts (inbound and outbound).
Field Summary
Field Attributes Field Name and Description
 
- list of ContextActionAllowed for this context
 
- current state of Telephony
 
- detail of the current state.
 
- textual representation for the ContextState
 
- time of the last context state change
 
- list of ContextSectionsAllowed available on the Inbound context.
 
- true if the inbound context is started.
 
- true if the outbound context is started.
 
- list of inbound and outbound Campaign available for transfering a call.
 
- list of ContextSectionsAllowed available on the Outbound context.
 
- number of inbound call in the agent personal queue.
 
- number of inbound call in the agent primary queue.
 
- list of CQueue available on this context (Inbound).
 
- list of CQueue available on this context (Outbound).
 
- number of inbound call in the agent secondary queue.
 
- list of TelephonySession running for this context.
Method Summary
Method Attributes Method Name and Description
 
ActionIsReady(action)
Used to know if an action is authorized on the context
 
Request to get the list of callbacks for the current hour on the Inbound context.
 
Request to get the list of callbacks for the current hour on the Outbound context.
 
Return the running session with the given id
 
ManualCall(campaignId, number, type, data, displayType, displayNumber)
Dial a call for a manual campaign.
 
Request the search mode on the outbound context.
 
Request to start receiving the production statistics informations on outbound context.
 
StartListeningQueueForProductionStatistics(queueId, group_filter, activeQueueFilter)
Request to start receiving the production statistics informations on inbound context.
 
StopListeningForProductionStatistics(stopInbound, stopOutbound)
Request to stop receiving the production statistics informations on telephony contexts.
Class Detail
TelephonyContext(agtCommands)
Manager for the telephony contexts (inbound and outbound). Instanciate by the AgentLinkClass object.
Parameters:
agtCommands
Field Detail
{COMArray} ActionsAllowed
- list of ContextActionAllowed for this context

{ContextStates} ContextState
- current state of Telephony

{number} ContextStateDetail
- detail of the current state. Enum to use depends of the ContextState.

{string} ContextStateLabel
- textual representation for the ContextState

{number} ContextStateTime
- time of the last context state change

{COMArray} InboundSectionsAllowed
- list of ContextSectionsAllowed available on the Inbound context.

{boolean} IsInboundStarted
- true if the inbound context is started.

{boolean} IsOutboundStarted
- true if the outbound context is started.

{COMArray} ListInOutboundCampaigns
- list of inbound and outbound Campaign available for transfering a call.

{COMArray} OutboundSectionsAllowed
- list of ContextSectionsAllowed available on the Outbound context.

{number} PersonalQueueSize
- number of inbound call in the agent personal queue.

{number} PrimaryQueueSize
- number of inbound call in the agent primary queue.

{COMArray} Queues
- list of CQueue available on this context (Inbound).

{COMArray} QueuesOutbound
- list of CQueue available on this context (Outbound).

{number} SecondaryQueueSize
- number of inbound call in the agent secondary queue.

{COMArray} Sessions
- list of TelephonySession running for this context.
Method Detail
ActionIsReady(action)
Used to know if an action is authorized on the context
    if (agentlink.Telephony.ActionIsReady(ContextActionAllowed.ManualCall)) {
		//agent can make call
	}
Parameters:
{ContextActionAllowed} action
- The action to test
Returns:
true if the action is currently authorized

CountNextInboundCallbacks()
Request to get the list of callbacks for the current hour on the Inbound context.
Will fire the "OnCountCallbacksComplete" event.

CountNextoutboundCallbacks(fctHandler)
Request to get the list of callbacks for the current hour on the Outbound context.
Will fire the "OnCountCallbacksComplete" event.
Parameters:
fctHandler

{TelephonySession} GetSession()
Return the running session with the given id
Returns:
{TelephonySession} . Throw exception if no session if active on the telephony contexts.

ManualCall(campaignId, number, type, data, displayType, displayNumber)
Dial a call for a manual campaign.
Before calling this function, verify the right ContextActionAllowed.ManualCall
Parameters:
{string} campaignId
- manual campaign id to use for the call
{string} number
- phone number to dial
{PhoneNumberTypes} type
- phone number type used to add a prefix if needed
{string} data
- Associated data (UUI)
{number} displayType
- type of phone number display for contact (Standard = 0, Specific = 1, Hidden = 2, Contact = 3)
{string} displayNumber
- phone number to display to contact when displayType = 1

RequestSearchMode()
Request the search mode on the outbound context.
Before calling this function, verify the right ContextActionAllowed.RequestSearchMode

StartListeningOutCampForProductionStatistics(campaignId, group_filter)
Request to start receiving the production statistics informations on outbound context.
Will fire the event "OnSupervisionDatasReceived".
Parameters:
{string} campaignId
- campaignId id to monitor. Empty string to monitor all campaigns for this context
{string} group_filter
- "true" to filter on agent supervising group, "false" to not filter statistics on supervising group

StartListeningQueueForProductionStatistics(queueId, group_filter, activeQueueFilter)
Request to start receiving the production statistics informations on inbound context.
Will fire the event "OnSupervisionDatasReceived".
Parameters:
{number} queueId
- queue id to monitor. "0" to monitor all queues for this context
{string} group_filter
- "true" to filter on agent supervising group, "false" to not filter statistics on supervising group
{string} activeQueueFilter
- "true" to filter on active queue, "false" to not filter statistics on active queues

StopListeningForProductionStatistics(stopInbound, stopOutbound)
Request to stop receiving the production statistics informations on telephony contexts.
Parameters:
{boolean} stopInbound
- if true, stop receiving informations on inbound context
{boolean} stopOutbound
- if true, stop receiving informations on outbound context

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Nov 05 2014 12:49:33 GMT+0100 (CET)