ICtiControl Interface

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2013, Dynamics CRM 2015, Dynamics CRM 2016

Represents the core interfaces for CTI components. This interface will be used by the desktop to determine if a control is a CTI host control.

Namespace: Microsoft.Uii.Desktop.Cti.Core
Assembly: Microsoft.Uii.Desktop.Cti.Core (in Microsoft.Uii.Desktop.Cti.Core.dll)

Syntax

public interface ICtiControl

Public Interface ICtiControl

	Name	Description
	AnswerCall(CtiCommandRequest)	Answers the call identified by the call ID.
	CleanUpAndShutdown()	Cleans up and shuts down any CTI specific functions and should be called as part of shutdown.
	ConferenceCall(CtiCommandRequest)	Orders a conference command.
	ExecuteGenericCommand(String, CtiCommandRequest)	Generic command handler. If the command does not exist in the currnet interface it can be extended via this interface.
	GetAgentId()	Gets the agent ID for the currently logged agent.
	GetGlobalAgentConfigVars()	Gets the agent configuration environment variables.
	HangUpCall(CtiCommandRequest)	Releases the call.
	HoldCall(CtiCommandRequest)	Holds the call identified by the CallID
	InitAndLogOn()	Initializes and logs the agent into CTI.
	LogOffAgent()	Logs the current agent out.
	MakeOutboundCall(CtiCommandRequest)	Dials an out bound number.
	PickupCall(CtiCommandRequest)	Picks a call up from hold.
	PushUrl(CtiCommandRequest)	Pushes a URL.
	RejectCall(CtiCommandRequest)	Rejects the call identified by the CallID
	SendChatMessage(CtiCommandRequest)	Sends a chat message to the call identified by the call ID.
	SetAgentMediaAddress(String)	Sets the agent’s media address.
	SetAgentState(CtiStateRequest)	Sets the agent state to the requested state.
	SetCallVariable(CtiCommandRequest)	Sets a call state variable on the CTI object for the specified call.
	TransferCall(CtiCommandRequest)	Orders a Transfer command
	WrapCall(CtiCommandRequest)	Wraps the call identified by the call ID.

	Name	Description
	AgentLogMessageEvent	Raised when a Agent Log Event occures
	AgentStateChangedEvent	Raised when a Agent State change Event occures
	CallDestructedEvent	Raised when a call terminated is generated
	CallItemEvent	Raised when a call Item Event is generated
	CallMediaConnectedEvent	Raised when the media endpoint connects.
	CallNewCallEvent	Raised when a new call is generated.
	CallNewCallInfoEvent	Raised when a new call info event is generated.
	CallStateChangeEvent	Raised when a call state event is generated.
	GeneralCtiEvent	Passes event data not covered in the named events.