DMCC.WebHook

Types and instances for implementing webhook interface for DMCC.

Documentation

data WHEvent

Web hook event.

Constructors

WHEvent

Fields

• agentId :: AgentId
• event :: AgentEvent

Instances

Show WHEvent

Methods

showsPrec :: Int -> WHEvent -> ShowS

show :: WHEvent -> String

showList :: [WHEvent] -> ShowS

ToJSON WHEvent

Methods

toJSON :: WHEvent -> Value

toEncoding :: WHEvent -> Encoding

toJSONList :: [WHEvent] -> Value

toEncodingList :: [WHEvent] -> Encoding

FromJSON WHEvent

Methods

parseJSON :: Value -> Parser WHEvent

parseJSONList :: Value -> Parser [WHEvent]

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 Event

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

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

ToJSON Event

Methods

toJSON :: Event -> Value

toEncoding :: Event -> Encoding

toJSONList :: [Event] -> Value

toEncodingList :: [Event] -> Encoding

FromJSON Event

Methods

parseJSON :: Value -> Parser Event

parseJSONList :: Value -> Parser [Event]