The first association between a call and a client (a route point, a CTI port, or an agent phone to which the agent has logged in) generates a BEGIN_CALL_EVENT message to the client, providing the call ID and the initial call context data. This message is optional. The CallID identifies the call, and the ConnectionDeviceType and ConnectionDeviceID uniquely identify the client’s local call connection, if any, or another valid call connection. This message always precedes any other event messages for that call. Subsequent changes to the call context data (if any) result in CALL_DATA_UPDATE_EVENT messages containing the changed call data being sent to the client. More...

Inheritance diagram for CTI.Messages.Response.Begin_Call_Event:

Public Member Functions
	Begin_Call_Event (Core.CTIMessage ctiMessage)

Public Member Functions inherited from CTI.Messages.Core.CTIMessage
	CTIMessage (uint messageType, bool generateInvokeId=true)

byte[]	GetBytes ()

CTIMessageFloatingField[]	GetFloatingPartFields (int fixedPartLength)

void	InitDataBuffer (uint length)

string	VarDump ()

string	ToJSON (bool includePrefix)

Protected Member Functions
override void	ParseDataBuffer ()

virtual void	ParseDataBuffer ()

Protected Attributes
List< CTIMessageNamedVariable >	namedVariables = new List<CTIMessageNamedVariable>()

List< CTIMessageNamedArray >	namedArray = new List<CTIMessageNamedArray>()

Protected Attributes inherited from CTI.Messages.Core.CTIMessage
uint	messageType = 0

CTIMessageHeader	header = null

OrderedDictionary	fixedPart = null

OrderedDictionary	floatingPart = null

byte[]	dataBuffer = null

DateTime	createTimestamp = DateTime.Now

Properties
uint	Reserved1 `[get]`
	Fixed Part Set this value to 0.

uint	Reserved2 `[get]`
	Fixed Part Set this value to 1.

ushort	Reserved3 `[get]`
	Fixed Part Set this value to 21.

ushort	NumCTIClients `[get]`
	Fixed Part The number of clients previously associated with this call. This value also indicates the number of client signatures and timestamps that are present in the floating part of the message.

ushort	NumNamedVariables `[get]`
	Fixed Part The number of NamedVariable floating fields present in the floating part of the message.

ushort	NumNamedArrays `[get]`
	Fixed Part The number of NamedArray floating fields present in the floating part of the message.

ushort	CallType `[get]`
	Fixed part The general classification of the call type. See: Consts.CallTypes

ushort	ConnectionDeviceType `[get]`
	Fixed Part The type of device ID supplied in the ConnectionDeviceID floating field. See: Consts.ConnectionDeviceTypes

string	ConnectionDeviceTypeString `[get]`
	String value of Begin_Call_Event.ConnectionDeviceType

uint	CallID `[get]`
	Fixed Price The Call ID value assigned to this call by Unified CCX.

ushort	CalledPartyDisposition `[get]`
	Fixed Part Indicates the disposition of the called party. See: Consts.Dispositions

string	ConnectionDeviceID `[get, protected set]`
	Floating Part (Required) The ID of the connection between the call and the device. In CTI Protocol Version 14, the general rules for the Primary.Actual Field Format will apply to this field. Length: String(64)

string	ANI `[get, protected set]`
	Floating Part (Optional) ANI (Automatic Number Identification). The telephone number of the person making the call. In CTI Protocol Version 14, the general rules for the Primary.Actual Field Format will apply to this field. Length: String(40)

string	DNIS `[get, protected set]`
	Floating Part (Optional) The DNIS (Dialed Number Identification Service) provided with the call; that is, the number associated with a call on a switch. This can be different, though often it is not, from the number the caller dialed. This is different if the call is transferred. In CTI Protocol Version 14, the general rules for the Primary.Actual Field Format will apply to this field. Length: String(32)

string	DialedNumber `[get, protected set]`
	Floating Part (Optional) The telephone number dialed. In CTI Protocol Version 14, the general rules for the Primary.Actual Field Format will apply to this field. Length: String(40)

string	CallerEnteredDigits `[get, protected set]`
	Floating Part (Optional) The digits entered by the caller in response to IVR prompting. Length: String(40)

string	CallVariable1 `[get, protected set]`
	Floating Part (Optional) Call-related variable data - CallVariable1. Length: String(40)

string	CallVariable2 `[get, protected set]`
	Floating Part (Optional) Call-related variable data - CallVariable2. Length: String(40)

string	CallVariable3 `[get, protected set]`
	Floating Part (Optional) Call-related variable data - CallVariable3. Length: String(40)

string	CallVariable4 `[get, protected set]`
	Floating Part (Optional) Call-related variable data - CallVariable4. Length: String(40)

string	CallVariable5 `[get, protected set]`
	Floating Part (Optional) Call-related variable data - CallVariable5. Length: String(40)

string	CallVariable6 `[get, protected set]`
	Floating Part (Optional) Call-related variable data - CallVariable6. Length: String(40)

string	CallVariable7 `[get, protected set]`
	Floating Part (Optional) Call-related variable data - CallVariable7. Length: String(40)

string	CallVariable8 `[get, protected set]`
	Floating Part (Optional) Call-related variable data - CallVariable8. Length: String(40)

string	CallVariable9 `[get, protected set]`
	Floating Part (Optional) Call-related variable data - CallVariable9. Length: String(40)

string	CallVariable10 `[get, protected set]`
	Floating Part (Optional) Call-related variable data - CallVariable10. Length: String(40)

string	CallWrapupData `[get, protected set]`
	Floating Part (Optional) Call-related wrapup data. !!! This field is not supported for the CTI clients that connect with version 17 and above. The Wrap-Up Reason value would now be returned in the NamedArray field. Length: String(40)

CTIMessageNamedVariable?	NamedVariable `[set]`

List< CTIMessageNamedVariable >	NamedVariables `[get]`
	Floating Part (Optional) Call-related variable data that has a variable name defined in the Unified CCX Editor. Length: NamedVar(251)

CTIMessageNamedArray?	NamedArrayMember `[set]`

List< CTIMessageNamedArray >	NamedArray `[get]`
	Floating Part (Optional) Call-related variable data that has an array variable name defined in the Unified CCX Editor. !!! The Wrap-Up Reasons are returned in the NamedArray fields with the key name, CCWRAPUP for the CTI clients that connect with version 17 and above. The maximum size of the Wrap-Up Reason value can be 40. A maximum number of five (5) Wrap-Up Reasons are allowed. Length: NamedArray(252)

Properties inherited from CTI.Messages.Core.CTIMessage
byte[]	DataBuffer `[get]`

CTIMessageHeader	Header `[get]`

uint	MessageType `[get]`

uint?	InvokeId `[get, set]`
	Fixed Party (Required/Optional) An ID for this request message that is returned in the corresponding confirm message.

DateTime	CreateTimestamp `[get]`

Detailed Description

The first association between a call and a client (a route point, a CTI port, or an agent phone to which the agent has logged in) generates a BEGIN_CALL_EVENT message to the client, providing the call ID and the initial call context data. This message is optional.

The CallID identifies the call, and the ConnectionDeviceType and ConnectionDeviceID uniquely identify the client’s local call connection, if any, or another valid call connection.

This message always precedes any other event messages for that call. Subsequent changes to the call context data (if any) result in CALL_DATA_UPDATE_EVENT messages containing the changed call data being sent to the client.

Member Function Documentation

◆ ParseDataBuffer()

override void CTI.Messages.Response.Begin_Call_Event.ParseDataBuffer ( )

inlineprotectedvirtual

Reimplemented from CTI.Messages.Core.CTIMessage.

The documentation for this class was generated from the following file:

Messages/Response/Begin_Call_Event.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ ParseDataBuffer()