DMCC

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

Documentation

data Session

Library API session.

Instances

Show Session

Methods

showsPrec :: Int -> Session -> ShowS

show :: Session -> String

showList :: [Session] -> ShowS

data ConnectionType

Constructors

Plain

TLS

Fields

• caDir :: Maybe FilePath

startSession

Arguments

:: (MonadUnliftIO m, MonadLoggerIO m, MonadBaseControl IO m, MonadCatch m)

=> (String, PortNumber)

Host and port of AES server.

-> ConnectionType

Use 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 ()

TODO Agent releasing notice

defaultSessionOptions :: SessionOptions

data AgentHandle

Instances

Eq AgentHandle

Methods

(==) :: AgentHandle -> AgentHandle -> Bool

(/=) :: AgentHandle -> AgentHandle -> Bool

Ord AgentHandle

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

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)

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 ()

Forget about an agent, releasing his device and monitors.

data Action

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

Methods

showsPrec :: Int -> Action -> ShowS

show :: Action -> String

showList :: [Action] -> ShowS

ToJSON Action

Methods

toJSON :: Action -> Value

toEncoding :: Action -> Encoding

toJSONList :: [Action] -> Value

toEncodingList :: [Action] -> Encoding

FromJSON Action

Methods

parseJSON :: Value -> Parser Action

parseJSONList :: Value -> Parser [Action]

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

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

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

Methods

showsPrec :: Int -> AgentEvent -> ShowS

show :: AgentEvent -> String

showList :: [AgentEvent] -> ShowS

ToJSON AgentEvent

Methods

toJSON :: AgentEvent -> Value

toEncoding :: AgentEvent -> Encoding

toJSONList :: [AgentEvent] -> Value

toEncodingList :: [AgentEvent] -> Encoding

FromJSON AgentEvent

Methods

parseJSON :: Value -> Parser AgentEvent

parseJSONList :: Value -> Parser [AgentEvent]

data AgentSnapshot

Constructors

AgentSnapshot

Fields

• _calls :: Map CallId Call
• _state :: (Maybe AgentState, Text)

  Last recognized agent state along with reason code.

Instances

Show AgentSnapshot

Methods

showsPrec :: Int -> AgentSnapshot -> ShowS

show :: AgentSnapshot -> String

showList :: [AgentSnapshot] -> ShowS

ToJSON AgentSnapshot

Methods

toJSON :: AgentSnapshot -> Value

toEncoding :: AgentSnapshot -> Encoding

toJSONList :: [AgentSnapshot] -> Value

toEncodingList :: [AgentSnapshot] -> Encoding

FromJSON AgentSnapshot

Methods

parseJSON :: Value -> Parser AgentSnapshot

parseJSONList :: Value -> Parser [AgentSnapshot]

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

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

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

module DMCC.Types