Safe Haskell	None
Language	Haskell2010

DMCC.XML.Response

Description

Incoming XML messages (responses and events).

Synopsis

data Response
- = UnknownResponse LByteString
- | MalformedResponse LByteString SomeException
- | StartApplicationSessionPosResponse {
  - sessionID :: Text
  - actualProtocolVersion :: Text
  - actualSessionDuration :: Int
  }
- | StartApplicationSessionNegResponse
- | GetDeviceIdResponse {
  - device :: DeviceId
  }
- | GetThirdPartyDeviceIdResponse {
  - device :: DeviceId
  }
- | MonitorStartResponse {
  - monitorCrossRefID :: Text
  }
- | MakeCallResponse {
  - newCallId :: CallId
  - newUcid :: UCID
  }
- | SingleStepConferenceCallResponse {
  - conferencedCall :: CallId
  }
- | GetAgentStateResponse {
  - agentState :: Maybe AgentState
  - reasonCode :: Text
  }
- | GetCallLinkageDataResponse {
  - linkageUcid :: UCID
  }
- | EventResponse {
  - monitorCrossRefID :: Text
  - event :: Event
  }
- | CSTAErrorCodeResponse {
  - errorText :: Text
  }
data Event
- = UnknownEvent
- | DeliveredEvent {
  - callId :: CallId
  - distributingVdn :: DeviceId
  - ucid :: UCID
  - callingDevice :: DeviceId
  - calledDevice :: DeviceId
  }
- | DivertedEvent {
  - callId :: CallId
  }
- | OriginatedEvent {
  - callId :: CallId
  - callingDevice :: DeviceId
  - calledDevice :: DeviceId
  }
- | EstablishedEvent {
  - callId :: CallId
  }
- | FailedEvent {
  - callId :: CallId
  }
- | ConnectionClearedEvent {
  - callId :: CallId
  - releasingDevice :: DeviceId
  }
- | HeldEvent {
  - callId :: CallId
  }
- | RetrievedEvent {
  - callId :: CallId
  }
- | ConferencedEvent {
  - primaryOldCall :: CallId
  - secondaryOldCall :: CallId
  }
- | TransferedEvent {
  - primaryOldCall :: CallId
  - secondaryOldCall :: CallId
  }
fromXml :: LByteString -> Response

Documentation

data Response Source #

DMCC response to a request.

Constructors

UnknownResponse LByteString
MalformedResponse LByteString SomeException
StartApplicationSessionPosResponse
Fields sessionID :: Text actualProtocolVersion :: Text actualSessionDuration :: Int
StartApplicationSessionNegResponse
GetDeviceIdResponse
Fields device :: DeviceId
GetThirdPartyDeviceIdResponse
Fields device :: DeviceId
MonitorStartResponse
Fields monitorCrossRefID :: Text
MakeCallResponse
Fields newCallId :: CallId newUcid :: UCID
SingleStepConferenceCallResponse
Fields conferencedCall :: CallId
GetAgentStateResponse
Fields agentState :: Maybe AgentState Nothing if an unknown state is reported. reasonCode :: Text
GetCallLinkageDataResponse
Fields linkageUcid :: UCID
EventResponse
Fields monitorCrossRefID :: Text event :: Event
CSTAErrorCodeResponse	Pretty-printed CSTAErrorCode message.
Fields errorText :: Text

Instances

Show Response Source #
Instance details Defined in DMCC.XML.Response Methods showsPrec :: Int -> Response -> ShowS # show :: Response -> String # showList :: [Response] -> ShowS #

data Event Source #

DMCC event.

Constructors

UnknownEvent
DeliveredEvent	Precedes every established/cleared event.
Fields callId :: CallId distributingVdn :: DeviceId ucid :: UCID callingDevice :: DeviceId calledDevice :: DeviceId
DivertedEvent
Fields callId :: CallId
OriginatedEvent
Fields callId :: CallId callingDevice :: DeviceId calledDevice :: DeviceId
EstablishedEvent
Fields callId :: CallId
FailedEvent
Fields callId :: CallId
ConnectionClearedEvent
Fields callId :: CallId releasingDevice :: DeviceId
HeldEvent
Fields callId :: CallId
RetrievedEvent
Fields callId :: CallId
ConferencedEvent
Fields primaryOldCall :: CallId secondaryOldCall :: CallId
TransferedEvent
Fields primaryOldCall :: CallId secondaryOldCall :: CallId

Instances

Show Event Source #
Instance details Defined in DMCC.XML.Response Methods showsPrec :: Int -> Event -> ShowS # show :: Event -> String # showList :: [Event] -> ShowS #
ToJSON Event Source #
Instance details Defined in DMCC.XML.Response Methods toJSON :: Event -> Value # toEncoding :: Event -> Encoding # toJSONList :: [Event] -> Value # toEncodingList :: [Event] -> Encoding #
FromJSON Event Source #
Instance details Defined in DMCC.XML.Response Methods parseJSON :: Value -> Parser Event # parseJSONList :: Value -> Parser [Event] #

fromXml :: LByteString -> Response Source #