Safe Haskell	None
Language	Haskell2010

DMCC

Description

DMCC XML API implementation for third party call control and monitoring.

Synopsis

data Session
startSession :: (MonadUnliftIO m, MonadLoggerIO m, MonadBaseControl IO m, MonadCatch m) => (String, PortNumber) -> Maybe FilePath -> Text -> Text -> Maybe String -> SessionOptions -> m Session
stopSession :: (MonadUnliftIO m, MonadLoggerIO m, MonadBaseControl IO m, MonadCatch m) => Session -> m ()
defaultSessionOptions :: SessionOptions
data AgentHandle
controlAgent :: (MonadUnliftIO m, MonadLoggerIO m, MonadBaseControl IO m, MonadMask m) => SwitchName -> Extension -> Session -> m (Either AgentError AgentHandle)
releaseAgent :: (MonadUnliftIO m, MonadLoggerIO m, MonadBaseControl IO m, MonadCatch m) => AgentHandle -> m ()
data Action
- = MakeCall {
  - number :: Extension
  }
- | AnswerCall {
  - callId :: CallId
  }
- | EndCall {
  - callId :: CallId
  }
- | HoldCall {
  - callId :: CallId
  }
- | RetrieveCall {
  - callId :: CallId
  }
- | BargeIn {
  - callId :: CallId
  - pType :: ParticipationType
  }
- | ConferenceCall {
  - activeCall :: CallId
  - heldCall :: CallId
  }
- | TransferCall {
  - activeCall :: CallId
  - heldCall :: CallId
  }
- | SendDigits {
  - callId :: CallId
  - digits :: Text
  }
- | SetState {
  - newState :: SettableAgentState
  }
agentAction :: (MonadLoggerIO m, MonadCatch m) => Action -> AgentHandle -> m ()
data AgentEvent
- = TelephonyEvent {
  - dmccEvent :: Event
  - newSnapshot :: AgentSnapshot
  }
- | StateChange {
  - newSnapshot :: AgentSnapshot
  }
- | TelephonyEventError {
  - errorText :: String
  }
- | RequestError {
  - errorText :: String
  }
data AgentSnapshot = AgentSnapshot {
- _calls :: Map CallId Call
- _state :: (Maybe AgentState, Text)
}
handleEvents :: (MonadLoggerIO m, MonadThrow m) => AgentHandle -> (AgentEvent -> m ()) -> m ThreadId
getAgentSnapshot :: (MonadLoggerIO m, MonadThrow m) => AgentHandle -> m AgentSnapshot
module DMCC.Types

Documentation

data Session Source #

Library API session.

Instances

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

startSession Source #

Arguments

:: (MonadUnliftIO m, MonadLoggerIO m, MonadBaseControl IO m, MonadCatch m)
=> (String, PortNumber)	Host and port of AES server.
-> Maybe FilePath	AES CA certificates directory for TLS.
-> Text	DMCC API user.
-> Text	DMCC API password.
-> Maybe String	Web hook URL.
-> SessionOptions
-> m Session

stopSession :: (MonadUnliftIO m, MonadLoggerIO m, MonadBaseControl IO m, MonadCatch m) => Session -> m () Source #

TODO Agent releasing notice

defaultSessionOptions :: SessionOptions Source #

data AgentHandle Source #

Instances

Eq AgentHandle Source #
Instance details Defined in DMCC.Agent Methods (==) :: AgentHandle -> AgentHandle -> Bool # (/=) :: AgentHandle -> AgentHandle -> Bool #
Ord AgentHandle Source #
Instance details Defined in DMCC.Agent Methods compare :: AgentHandle -> AgentHandle -> Ordering # (<) :: AgentHandle -> AgentHandle -> Bool # (<=) :: AgentHandle -> AgentHandle -> Bool # (>) :: AgentHandle -> AgentHandle -> Bool # (>=) :: AgentHandle -> AgentHandle -> Bool # max :: AgentHandle -> AgentHandle -> AgentHandle # min :: AgentHandle -> AgentHandle -> AgentHandle #
Show AgentHandle Source #
Instance details Defined in DMCC.Agent Methods showsPrec :: Int -> AgentHandle -> ShowS # show :: AgentHandle -> String # showList :: [AgentHandle] -> ShowS #

controlAgent :: (MonadUnliftIO m, MonadLoggerIO m, MonadBaseControl IO m, MonadMask m) => SwitchName -> Extension -> Session -> m (Either AgentError AgentHandle) Source #

Enable an active agent to be monitored and controlled through DMCC API. If the agent has already been registered, return the old entry (it's safe to call this function with the same arguments multiple times).

releaseAgent :: (MonadUnliftIO m, MonadLoggerIO m, MonadBaseControl IO m, MonadCatch m) => AgentHandle -> m () Source #

Forget about an agent, releasing his device and monitors.

data Action Source #

Actions performable by a controlled agent.

Constructors

MakeCall
Fields number :: Extension
AnswerCall
Fields callId :: CallId
EndCall
Fields callId :: CallId
HoldCall
Fields callId :: CallId
RetrieveCall
Fields callId :: CallId
BargeIn
Fields callId :: CallId pType :: ParticipationType
ConferenceCall
Fields activeCall :: CallId heldCall :: CallId
TransferCall
Fields activeCall :: CallId heldCall :: CallId
SendDigits
Fields callId :: CallId digits :: Text
SetState
Fields newState :: SettableAgentState

Instances

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

agentAction :: (MonadLoggerIO m, MonadCatch m) => Action -> AgentHandle -> m () Source #

Command an agent to do something.

Due to lack of global locking of the agents map an agent may be gone (released) by the time an action arrives to its actionChan. This is by design to avoid congestion during action processing.

data AgentEvent Source #

Events/errors are published to external clients of the agents and may be used by agent subscribers to provide information to user.

Constructors

TelephonyEvent	A telephony-related event, along with an updated snapshot.
Fields dmccEvent :: Event newSnapshot :: AgentSnapshot
StateChange	Arrives when an agent state change has been observed.
Fields newSnapshot :: AgentSnapshot
TelephonyEventError	An error caused by a telephony-related event.
Fields errorText :: String
RequestError	An error caused by a request from this agent.
Fields errorText :: String

Instances

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

data AgentSnapshot Source #

Constructors

AgentSnapshot
Fields _calls :: Map CallId Call _state :: (Maybe AgentState, Text) Last recognized agent state along with reason code.

Instances

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

handleEvents :: (MonadLoggerIO m, MonadThrow m) => AgentHandle -> (AgentEvent -> m ()) -> m ThreadId Source #

Attach an event handler to an agent. Exceptions are not handled.

getAgentSnapshot :: (MonadLoggerIO m, MonadThrow m) => AgentHandle -> m AgentSnapshot Source #

module DMCC.Types