UCCX CTI
Loading...
Searching...
No Matches
Protected Attributes | Properties | List of all members
CTI.Messages.Request.Set_Call_Data_Req Class Reference

This message is sent by a client or Unified CCX to set one or more call variables and/or call wrap-up data. The combination of CallID, ConnectionDeviceType, and ConnectionDeviceID uniquely identify the call to be operated on. Variables not provided in the message are not affected. The SET_CALL_DATA_REQ and SET_CALL_DATA_CONF messages are defined in the following table and in SET_CALL_DATA_CONF. Required fields:

More...

Inheritance diagram for CTI.Messages.Request.Set_Call_Data_Req:
CTI.Messages.Core.CTIMessage

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

ushort ConnectionDeviceType [get, set]
 Fixed Part (Required) The type of device ID supplied in the ConnectionDeviceID floating field. See: Consts.ConnectionDeviceTypes
 
string ConnectionDeviceTypeString [get]
 String value of Set_Call_Data_Req.ConnectionDeviceType
 
uint CallID [get, set]
 Fixed Part (Required) The Call ID value assigned to the call by Unified CCX.
 
ushort NumNamedVariables [get]
 Fixed Part (Required) The number of NamedVariable floating fields present in the floating part of the message.
 
ushort NumNamedArrays [get]
 Fixed Part (Required) The number of NamedArray floating fields present in the floating part of the message.
 
ushort CallType [get, set]
 Fixed Part (Required) The general classification of the call type. See: Consts.CallTypes
 
ushort CalledPartyDisposition [get, set]
 Fixed Part (Required) Indicates the disposition of the called party.
 
string ConnectionDeviceID [get, set]
 Floating Part (Required) The ID of the connection between the call and the device. Length: String(64)
 
string ANI [get, set]
 Floating Part (Optional) The calling line ID of the caller. Length: String(40)
 
string CallerEnteredDigits [get, set]
 Floating Part (Optional) The digits entered by the caller in response to IVR prompting. Length: String(40)
 
string CallVariable1 [get, set]
 Floating Part (Optional) Call-related variable data - CallVariable1. Length: String(40)
 
string CallVariable2 [get, set]
 Floating Part (Optional) Call-related variable data - CallVariable2. Length: String(40)
 
string CallVariable3 [get, set]
 Floating Part (Optional) Call-related variable data - CallVariable3. Length: String(40)
 
string CallVariable4 [get, set]
 Floating Part (Optional) Call-related variable data - CallVariable4. Length: String(40)
 
string CallVariable5 [get, set]
 Floating Part (Optional) Call-related variable data - CallVariable5. Length: String(40)
 
string CallVariable6 [get, set]
 Floating Part (Optional) Call-related variable data - CallVariable6. Length: String(40)
 
string CallVariable7 [get, set]
 Floating Part (Optional) Call-related variable data - CallVariable7. Length: String(40)
 
string CallVariable8 [get, set]
 Floating Part (Optional) Call-related variable data - CallVariable8. Length: String(40)
 
string CallVariable9 [get, set]
 Floating Part (Optional) Call-related variable data - CallVariable9. Length: String(40)
 
string CallVariable10 [get, set]
 Floating Part (Optional) Call-related variable data - CallVariable10. Length: String(40)
 
string CallWrapupData [get, 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 is now expected in the NamedArray field with a key value. Length: String(40)
 
CTIMessageNamedVariable? NamedVariable [set]
 
List< CTIMessageNamedVariable > NamedVariables [get, set]
 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, set]
 Floating Part (Optional) Call-related variable data that has an array variable name defined in the Unified CCX Editor. !!! The Wrap-Up Reason is now expected in the NamedArray field with the key name, CCWRAPUP. 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)
 
string CustomerAccountNumber [get, set]
 Floating Part (Optional) Customer Account Number. Length: String(40)
 
- 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]
 

Additional Inherited Members

- 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 inherited from CTI.Messages.Core.CTIMessage
virtual void ParseDataBuffer ()
 

Detailed Description

This message is sent by a client or Unified CCX to set one or more call variables and/or call wrap-up data. The combination of CallID, ConnectionDeviceType, and ConnectionDeviceID uniquely identify the call to be operated on. Variables not provided in the message are not affected.

The SET_CALL_DATA_REQ and SET_CALL_DATA_CONF messages are defined in the following table and in SET_CALL_DATA_CONF.

Required fields:

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.6