@ipcom/extended-ami/src/e-ami.d.ts

Advanced manager for connecting to Asterisk

import { Socket } from "net";
import { EventEmitter } from "events";
import { I_Request } from "./interfaces/actions.interface.js";
import { eAmiActions } from "./e-ami-actions.js";
import {
    AMIEvent,
    AGIExecEnd,
    AGIExecStart,
    AOCD,
    AOCE,
    AOCS,
    AgentCalled,
    AgentComplete,
    AgentConnect,
    AgentDump,
    AgentLogin,
    AgentLogoff,
    AgentRingNoAnswer,
    Agents,
    AgentsComplete,
    Alarm,
    AlarmClear,
    AorDetail,
    AorList,
    AorListComplete,
    AsyncAGIEnd,
    AsyncAGIExec,
    AsyncAGIStart,
    AttendedTransfer,
    AuthDetail,
    AuthList,
    AuthListComplete,
    AuthMethodNotAllowed,
    BlindTransfer,
    BridgeCreate,
    BridgeDestroy,
    BridgeEnter,
    BridgeInfoChannel,
    BridgeInfoComplete,
    BridgeLeave,
    BridgeMerge,
    BridgeVideoSourceUpdate,
    CEL,
    Cdr,
    ChallengeResponseFailed,
    ChallengeSent,
    ChanSpyStart,
    ChanSpyStop,
    ChannelTalkingStart,
    ChannelTalkingStop,
    ConfbridgeEnd,
    ConfbridgeJoin,
    ConfbridgeLeave,
    ConfbridgeList,
    ConfbridgeListRooms,
    ConfbridgeMute,
    ConfbridgeRecord,
    ConfbridgeStart,
    ConfbridgeStopRecord,
    ConfbridgeTalking,
    ConfbridgeUnmute,
    ContactList,
    ContactListComplete,
    ContactStatus,
    ContactStatusDetail,
    CoreShowChannel,
    CoreShowChannelMapComplete,
    CoreShowChannelsComplete,
    DAHDIChannel,
    DNDState,
    DTMFBegin,
    DTMFEnd,
    DeadlockStart,
    DeviceStateChange,
    DeviceStateListComplete,
    DialBegin,
    DialEnd,
    DialState,
    EndpointDetail,
    EndpointDetailComplete,
    EndpointList,
    EndpointListComplete,
    ExtensionStateListComplete,
    ExtensionStatus,
    FAXSession,
    FAXSessionsComplete,
    FAXSessionsEntry,
    FAXStats,
    FAXStatus,
    FailedACL,
    Flash,
    FullyBooted,
    Hangup,
    HangupHandlerPop,
    HangupHandlerPush,
    HangupHandlerRun,
    HangupRequest,
    Hold,
    IdentifyDetail,
    InvalidAccountID,
    InvalidPassword,
    InvalidTransport,
    Load,
    LoadAverageLimit,
    LocalBridge,
    LocalOptimizationBegin,
    LocalOptimizationEnd,
    LogChannel,
    MCID,
    MWIGet,
    MWIGetComplete,
    MeetmeEnd,
    MeetmeJoin,
    MeetmeLeave,
    MeetmeList,
    MeetmeListRooms,
    MeetmeMute,
    MeetmeTalkRequest,
    MeetmeTalking,
    MemoryLimit,
    MessageWaiting,
    MiniVoiceMail,
    MixMonitorMute,
    MixMonitorStart,
    MixMonitorStop,
    MonitorStart,
    MonitorStop,
    MusicOnHoldStart,
    MusicOnHoldStop,
    NewAccountCode,
    NewCallerid,
    NewConnectedLine,
    NewExten,
    Newchannel,
    Newstate,
    OriginateResponse,
    ParkedCall,
    ParkedCallGiveUp,
    ParkedCallSwap,
    ParkedCallTimeOut,
    PeerStatus,
    Pickup,
    PresenceStateChange,
    PresenceStateListComplete,
    PresenceStatus,
    QueueCallerAbandon,
    QueueCallerJoin,
    QueueCallerLeave,
    QueueEntry,
    QueueMemberAdded,
    QueueMemberPause,
    QueueMemberPenalty,
    QueueMemberRemoved,
    QueueMemberRinginuse,
    QueueMemberStatus,
    QueueParams,
    RTCPReceived,
    RTCPSent,
    ReceiveFAX,
    Registry,
    Reload,
    Rename,
    RequestBadFormat,
    RequestNotAllowed,
    RequestNotSupported,
    SIPQualifyPeerDone,
    SendFAX,
    SessionLimit,
    SessionTimeout,
    Shutdown,
    SoftHangupRequest,
    SpanAlarm,
    SpanAlarmClear,
    Status,
    StatusComplete,
    SuccessfulAuth,
    TransportDetail,
    UnParkedCall,
    UnexpectedAddress,
    Unhold,
    Unload,
    UserEvent,
    VarSet,
    VoicemailPasswordChange,
    Wink,
} from './types/events.js';

declare namespace extended_ami {
    import Timer = NodeJS.Timer;

    // Exporting types from "types/events"
    export type AGIExecEnd = AGIExecEnd;
    export type AGIExecStart = AGIExecStart;
    export type AOCD = AOCD;
    export type AOCE = AOCE;
    export type AOCS = AOCS;
    export type AgentCalled = AgentCalled;
    export type AgentComplete = AgentComplete;
    export type AgentConnect = AgentConnect;
    export type AgentDump = AgentDump;
    export type AgentLogin = AgentLogin;
    export type AgentLogoff = AgentLogoff;
    export type AgentRingNoAnswer = AgentRingNoAnswer;
    export type Agents = Agents;
    export type AgentsComplete = AgentsComplete;
    export type Alarm = Alarm;
    export type AlarmClear = AlarmClear;
    export type AorDetail = AorDetail;
    export type AorList = AorList;
    export type AorListComplete = AorListComplete;
    export type AsyncAGIEnd = AsyncAGIEnd;
    export type AsyncAGIExec = AsyncAGIExec;
    export type AsyncAGIStart = AsyncAGIStart;
    export type AttendedTransfer = AttendedTransfer;
    export type AuthDetail = AuthDetail;
    export type AuthList = AuthList;
    export type AuthListComplete = AuthListComplete;
    export type AuthMethodNotAllowed = AuthMethodNotAllowed;
    export type BlindTransfer = BlindTransfer;
    export type BridgeCreate = BridgeCreate;
    export type BridgeDestroy = BridgeDestroy;
    export type BridgeEnter = BridgeEnter;
    export type BridgeInfoChannel = BridgeInfoChannel;
    export type BridgeInfoComplete = BridgeInfoComplete;
    export type BridgeLeave = BridgeLeave;
    export type BridgeMerge = BridgeMerge;
    export type BridgeVideoSourceUpdate = BridgeVideoSourceUpdate;
    export type CEL = CEL;
    export type Cdr = Cdr;
    export type ChallengeResponseFailed = ChallengeResponseFailed;
    export type ChallengeSent = ChallengeSent;
    export type ChanSpyStart = ChanSpyStart;
    export type ChanSpyStop = ChanSpyStop;
    export type ChannelTalkingStart = ChannelTalkingStart;
    export type ChannelTalkingStop = ChannelTalkingStop;
    export type ConfbridgeEnd = ConfbridgeEnd;
    export type ConfbridgeJoin = ConfbridgeJoin;
    export type ConfbridgeLeave = ConfbridgeLeave;
    export type ConfbridgeList = ConfbridgeList;
    export type ConfbridgeListRooms = ConfbridgeListRooms;
    export type ConfbridgeMute = ConfbridgeMute;
    export type ConfbridgeRecord = ConfbridgeRecord;
    export type ConfbridgeStart = ConfbridgeStart;
    export type ConfbridgeStopRecord = ConfbridgeStopRecord;
    export type ConfbridgeTalking = ConfbridgeTalking;
    export type ConfbridgeUnmute = ConfbridgeUnmute;
    export type ContactList = ContactList;
    export type ContactListComplete = ContactListComplete;
    export type ContactStatus = ContactStatus;
    export type ContactStatusDetail = ContactStatusDetail;
    export type CoreShowChannel = CoreShowChannel;
    export type CoreShowChannelMapComplete = CoreShowChannelMapComplete;
    export type CoreShowChannelsComplete = CoreShowChannelsComplete;
    export type DAHDIChannel = DAHDIChannel;
    export type DNDState = DNDState;
    export type DTMFBegin = DTMFBegin;
    export type DTMFEnd = DTMFEnd;
    export type DeadlockStart = DeadlockStart;
    export type DeviceStateChange = DeviceStateChange;
    export type DeviceStateListComplete = DeviceStateListComplete;
    export type DialBegin = DialBegin;
    export type DialEnd = DialEnd;
    export type DialState = DialState;
    export type EndpointDetail = EndpointDetail;
    export type EndpointDetailComplete = EndpointDetailComplete;
    export type EndpointList = EndpointList;
    export type EndpointListComplete = EndpointListComplete;
    export type ExtensionStateListComplete = ExtensionStateListComplete;
    export type ExtensionStatus = ExtensionStatus;
    export type FAXSession = FAXSession;
    export type FAXSessionsComplete = FAXSessionsComplete;
    export type FAXSessionsEntry = FAXSessionsEntry;
    export type FAXStats = FAXStats;
    export type FAXStatus = FAXStatus;
    export type FailedACL = FailedACL;
    export type Flash = Flash;
    export type FullyBooted = FullyBooted;
    export type Hangup = Hangup;
    export type HangupHandlerPop = HangupHandlerPop;
    export type HangupHandlerPush = HangupHandlerPush;
    export type HangupHandlerRun = HangupHandlerRun;
    export type HangupRequest = HangupRequest;
    export type Hold = Hold;
    export type IdentifyDetail = IdentifyDetail;
    export type InvalidAccountID = InvalidAccountID;
    export type InvalidPassword = InvalidPassword;
    export type InvalidTransport = InvalidTransport;
    export type Load = Load;
    export type LoadAverageLimit = LoadAverageLimit;
    export type LocalBridge = LocalBridge;
    export type LocalOptimizationBegin = LocalOptimizationBegin;
    export type LocalOptimizationEnd = LocalOptimizationEnd;
    export type LogChannel = LogChannel;
    export type MCID = MCID;
    export type MWIGet = MWIGet;
    export type MWIGetComplete = MWIGetComplete;
    export type MeetmeEnd = MeetmeEnd;
    export type MeetmeJoin = MeetmeJoin;
    export type MeetmeLeave = MeetmeLeave;
    export type MeetmeList = MeetmeList;
    export type MeetmeListRooms = MeetmeListRooms;
    export type MeetmeMute = MeetmeMute;
    export type MeetmeTalkRequest = MeetmeTalkRequest;
    export type MeetmeTalking = MeetmeTalking;
    export type MemoryLimit = MemoryLimit;
    export type MessageWaiting = MessageWaiting;
    export type MiniVoiceMail = MiniVoiceMail;
    export type MixMonitorMute = MixMonitorMute;
    export type MixMonitorStart = MixMonitorStart;
    export type MixMonitorStop = MixMonitorStop;
    export type MonitorStart = MonitorStart;
    export type MonitorStop = MonitorStop;
    export type MusicOnHoldStart = MusicOnHoldStart;
    export type MusicOnHoldStop = MusicOnHoldStop;
    export type NewAccountCode = NewAccountCode;
    export type NewCallerid = NewCallerid;
    export type NewConnectedLine = NewConnectedLine;
    export type NewExten = NewExten;
    export type Newchannel = Newchannel;
    export type Newstate = Newstate;
    export type OriginateResponse = OriginateResponse;
    export type ParkedCall = ParkedCall;
    export type ParkedCallGiveUp = ParkedCallGiveUp;
    export type ParkedCallSwap = ParkedCallSwap;
    export type ParkedCallTimeOut = ParkedCallTimeOut;
    export type PeerStatus = PeerStatus;
    export type Pickup = Pickup;
    export type PresenceStateChange = PresenceStateChange;
    export type PresenceStateListComplete = PresenceStateListComplete;
    export type PresenceStatus = PresenceStatus;
    export type QueueCallerAbandon = QueueCallerAbandon;
    export type QueueCallerJoin = QueueCallerJoin;
    export type QueueCallerLeave = QueueCallerLeave;
    export type QueueEntry = QueueEntry;
    export type QueueMemberAdded = QueueMemberAdded;
    export type QueueMemberPause = QueueMemberPause;
    export type QueueMemberPenalty = QueueMemberPenalty;
    export type QueueMemberRemoved = QueueMemberRemoved;
    export type QueueMemberRinginuse = QueueMemberRinginuse;
    export type QueueMemberStatus = QueueMemberStatus;
    export type QueueParams = QueueParams;
    export type RTCPReceived = RTCPReceived;
    export type RTCPSent = RTCPSent;
    export type ReceiveFAX = ReceiveFAX;
    export type Registry = Registry;
    export type Reload = Reload;
    export type Rename = Rename;
    export type RequestBadFormat = RequestBadFormat;
    export type RequestNotAllowed = RequestNotAllowed;
    export type RequestNotSupported = RequestNotSupported;
    export type SIPQualifyPeerDone = SIPQualifyPeerDone;
    export type SendFAX = SendFAX;
    export type SessionLimit = SessionLimit;
    export type SessionTimeout = SessionTimeout;
    export type Shutdown = Shutdown;
    export type SoftHangupRequest = SoftHangupRequest;
    export type SpanAlarm = SpanAlarm;
    export type SpanAlarmClear = SpanAlarmClear;
    export type Status = Status;
    export type StatusComplete = StatusComplete;
    export type SuccessfulAuth = SuccessfulAuth;
    export type TransportDetail = TransportDetail;
    export type UnParkedCall = UnParkedCall;
    export type UnexpectedAddress = UnexpectedAddress;
    export type Unhold = Unhold;
    export type Unload = Unload;
    export type UserEvent = UserEvent;
    export type VarSet = VarSet;
    export type VoicemailPasswordChange = VoicemailPasswordChange;
    export type Wink = Wink;

    // Exporting your type guards functions
    export function isAgentComplete(evt: AMIEvent): evt is AgentComplete;
    export function isAgentCalled(evt: AMIEvent): evt is AgentCalled;

    /**
     * Configure option interfaces
     *
     */
    export interface IeAmiOptions {
        host: string
        port: number
        userName: string
        password: string

        additionalOptions?: IAddinionalOptions
    }

    export interface IAddinionalOptions {

        //Output messages to the console
        debug?: boolean
        //Delay before resending a command (in seconds)
        timeOutSend?: number
        //resend message on after timeout
        resendAction?: boolean
        //reconnect after timeout defibrillation
        reconnect?: boolean
        maxReconnectCount?: number
        emitAllEvents?: boolean
        // in seconds
        timeOutToDefibrillation?: number

        //ping command frequency
        heartbeatInterval?: number

        //list of excluded events
        excludeEvents?: string[]
    }

    /**
     * Asterisk manager actions
     *
     */
    export interface I_Response {
        Event?: string
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        Request?: I_Request

        [p: string]: string | number | boolean | I_Request | undefined;
    }

    export interface I_Request {
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        Action?: string
        //Timestamp of start request
        TimeStart?: number
        Completed?: boolean

        [field: string]: string | number | boolean | undefined;
    }

    //Bridge two channels already in the PBX
    export interface I_ActionBridge {
        Action?: "Bridge"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        // Channel to Bridge to Channel2.
        Channel1: string
        // Channel to Bridge to Channel1.
        Channel2: string
        //Play courtesy tone to Channel 2.
        Tone: "no" | "Channel1" | "Channel2" | "Both"
    }

    //Destroy a bridge.
    //Deletes the bridge, causing channels to continue or hang up.
    export interface I_ActionBridgeDestroy {
        Action: "BridgeDestroy"
        ActionID: number | string
        //The unique ID of the bridge to destroy.
        BridgeUniqueid: string
    }

    //Get information about a bridge
    export interface I_ActionBridgeInfo {
        Action?: "BridgeInfo"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        //The unique ID of the bridge about which to retrieve information.
        BridgeUniqueid: string
    }

    //Kick a channel from a bridge.
    export interface I_ActionBridgeKick {
        Action?: "BridgeKick"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        BridgeUniqueid?: string
        Channel: string
    }

    //Get a list of bridges in the system
    export interface I_ActionBridgeList {
        Action?: "BridgeList"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        //Optional type for filtering the resulting list of bridges.
        BridgeType?: string
    }

    //List currently active channels.
    //List currently defined channels and some information about them.
    export interface I_ActionCoreShowChannels {
        Action?: "CoreShowChannels"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
    }

    //Hangup channel.
    export interface I_ActionHangup {
        Action?: "Hangup"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        //The exact channel name to be hungup, or to use a regular expression, set this parameter to: /regex/
        Channel: string
        Cause?: string
    }

    //Login Manager
    export interface I_ActionLogin {
        Action?: "Login"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        //Username to login with as specified in manager.conf.
        Username: string
        // Secret to login with as specified in manager.conf.
        Secret: string
    }

    //Logoff the current manager session.
    export interface I_ActionLogout {
        Action?: "Logoff"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
    }

    //Generates an outgoing call to a Extension/Context/Priority or Application/Data
    export interface I_ActionOriginate {
        Action?: "Originate"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        //Channel name to call
        Channel: string
        //Extension to use (requires Context and Priority)
        Exten: number
        //Context to use (requires Exten and Priority)
        Context: string
        //Priority to use (requires Exten and Context)
        Priority?: number
        //Application to execute.
        Application?: string
        //Data to use (requires Application).
        Data?: string
        //How long to wait for call to be answered (in ms.).
        Timeout: number
        //Caller ID to be set on the outgoing channel.
        CallerID?: number
        //Channel variable to set, multiple Variable: headers are allowed.
        Variable?: string
        Account?: string
        // Set to true to force call bridge on early media..
        EarlyMedia?: boolean
        //Set to true for fast origination.
        Async?: boolean
        //Comma-separated list of codecs to use for this call.
        Codecs?: string
        //Channel UniqueId to be set on the channel.
        ChannelId?: string
        //Channel UniqueId to be set on the second local channel.
        OtherChannelId?: string
    }

    export interface I_ActionPing {
        Action?: "Ping"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
    }

    //Check the status of one or more queues.
    export interface I_ActionQueueStatus {
        Action?: "QueueStatus"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        //Limit the response to the status of the specified queue.
        Queue: string
        //Limit the response to the status of the specified member.
        Member?: string
        //Real number of members of the queue (It is necessary in case of an incorrect response from asterisk)
        MembersCount?: number
    }

    //Request the manager to send a QueueSummary event.
    export interface I_ActionQueueSummary {
        Action?: "QueueSummary"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        //Queue for which the summary is requested.
        Queue: string
    }

    //Add interface to queue.
    export interface I_ActionQueueAdd {
        Action?: "QueueAdd"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        Queue: string
        //The name of the interface (tech/name) to add to the queue.
        Interface: string
        //A penalty (number) to apply to this member. Asterisk will distribute calls to members with higher penalties
        // only after attempting to distribute calls to those with lower penalty.
        Panalty: number
        //To pause or not the member initially (true/false or 1/0).
        Paused: boolean
        //Text alias for the interface.
        MemberName: string
        StateInterface: string
    }

    //Remove interface from queue.
    export interface I_ActionQueueRemove {
        Action?: "QueueRemove"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        //The name of the queue to take action on.
        Queue: string
        //The interface (tech/name) to remove from queue.
        Interface: string
    }

    // Set the penalty for a queue member.
    // Change the penalty of a queue member
    export interface I_ActionQueuePenalty {
        Action?: "QueuePenalty"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        //The interface (tech/name) of the member whose penalty to change.
        Interface: string
        //The new penalty (number) for the member. Must be nonnegative.
        Penalty: number
        //If specified, only set the penalty for the member of this queue.
        // Otherwise, set the penalty for the member in all queues to which the member belongs.
        Queue: string

    }


    //Show queues information.
    export interface I_ActionQueues {
        Action?: "Queues"
    }

    //Makes a queue member temporarily unavailable.
    //Pause or unpause a member in a queue.
    export interface I_ActionQueuePause {
        Action?: "QueuePause"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        //The name of the interface (tech/name) to pause or unpause.
        Interface: string
        //Pause or unpause the interface. Set to 'true' to pause the member or 'false' to unpause.
        Paused: boolean
        //The name of the queue in which to pause or unpause this member.
        // If not specified, the member will be paused or unpaused in all the queues it is a member of.
        Queue: string
        //Text description, returned in the event QueueMemberPaused.
        Reason?: string
    }

    //List SIP peers (text format).
    //Lists SIP peers in text format with details on current status.
    // Peerlist will follow as separate events, followed by a final event called PeerlistComplete.
    export interface I_ActionSIPpeers {
        Action?: "SIPpeers"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
    }

    //Show the status of one or all of the sip peers.
    //Retrieves the status of one or all of the sip peers. If no peer name is specified, status for all of the sip peers will be retrieved.
    export interface I_ActonSIPpeerstatus {
        Action?: "SIPpeerstatus"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        //The peer name you want to check.
        Peer?: string
    }

    //show SIP peer (text format).
    //Show one SIP peer with details on current status.
    export interface I_ActionSIPshowpeer {
        Action?: "SIPpeerstatus"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        //The peer name you want to check.
        Peer?: string
    }

    //Show SIP registrations (text format).
    //Lists all registration requests and status. Registrations will follow as separate events
    // followed by a final event called RegistrationsComplete.
    export interface I_ActionSIPshowregistry {
        Action?: "SIPshowregistry"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
    }

    //List channel status.
    //Will return the status information of each channel along with the value for the specified channel variables.
    export interface I_ActionStatus {
        Action?: "Status"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        //The name of the channel to query for status.
        Channel: string
        //Comma , separated list of variable to include.
        Variables?: string
        //If set to "true", the Status event will include all channel variables for the requested channel(s).
        AllVariables?: boolean
    }

    //Send an arbitrary event.
    //Send an event to manager sessions.
    export interface I_ActionUserEvent {
        Action?: "UserEvent"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        // Event string to send.
        UserEvent: string
        //Contents
        Header1: string

        [HeaderN: string]: string | number | boolean | undefined;
    }

    //Wait for an event to occur.
    //This action will ellicit a Success response. Whenever a manager event is queued.
    // Once WaitEvent has been called on an HTTP manager session, events will be generated and queued.
    export interface I_ActionWaitEvent {
        Action?: "waitEvent"
        //ActionID for this transaction. Will be returned.
        ActionID?: number | string
        //Maximum time (in seconds) to wait for events, -1 means forever.
        Timeout: number
    }


    /**
     * Bridge event interfaces
     *
     */
    export interface I_BridgeEnter {
        Event: string                   //'BridgeEnter',
        Privilege: string               //'call,all',
        BridgeUniqueid: string          //'009e8c7a-7204-466b-bc08-83ed629669d6',
        //The type of bridge
        BridgeType: string              //'basic',
        //Technology in use by the bridge
        BridgeTechnology: string        //'simple_bridge',
        //Entity that created the bridge if applicable
        BridgeCreator: string           //null,
        //Name used to refer to the bridge by its BridgeCreator if applicable
        BridgeName: string              //null,
        // Number of channels in the bridge
        BridgeNumChannels: number       //1,                  2
        //The video source mode for the bridge.
        BridgeVideoSourceMode?: "talker" | "single" | string   //'none',
        //If there is a video source for the bridge, the unique ID of the channel that is the video source.
        BridgeVideoSource?: string
        Channel: string                 //'SIP/107-00042237',   SIP/mtt-out-00042236
        //A numeric code for the channel's current state, related to ChannelStateDesc
        ChannelState: number            //6,
        ChannelStateDesc: "Down" |
          "Rsrvd" |
          "offHook" |
          "Diealing" |
          "Ring" |
          "Ringing" |
          "Up" |
          "Busy" |
          "Dialing Offhook" |
          "Pre-ring" |
          "Unknown" |
          string        //'Up',
        CallerIDNum: number             //null,          89******353
        CallerIDName: string            //null,
        ConnectedLineNum: number        //89*******53,        null
        ConnectedLineName: string       //null,
        Language: string                //'ru',
        AccountCode: number             //'',
        Context: string                 //'callcenter',         menuivr
        Exten: number                   // null,
        Priority: number                // 1,                  8
        Uniqueid: number                //'1527245698.556770',  1527245675.556769
        //Uniqueid of the oldest channel associated with this channel.
        Linkedid: number                //'1527245675.556769'   1527245675.556769
        SwapUniqueid?: number
    }

    export interface I_BridgeCreate {
        Event: string
        BridgeUniqueid: string
        BridgeType: string
        BridgeTechnology: string
        // Entity that created the bridge if applicable
        BridgeCreator: string
        //Name used to refer to the bridge by its BridgeCreator if applicable
        BridgeName: string
        BridgeNumChannels: number
        //The video source mode for the bridge.
        BridgeVideoSourceMode?: "talker" | "single" | string   //'none',
        //If there is a video source for the bridge, the unique ID of the channel that is the video source.
        BridgeVideoSource?: string
    }

    export interface I_BridgeLeave {
        Event: string                   //'BridgeLeave',
        Privilege: string               //'call,all',
        BridgeUniqueid: string          //'009e8c7a-7204-466b-bc08-83ed629669d6',
        //The type of bridge
        BridgeType: string              //'basic',
        //Technology in use by the bridge
        BridgeTechnology: string        //'simple_bridge',
        //Entity that created the bridge if applicable
        BridgeCreator: string           //null,
        //Name used to refer to the bridge by its BridgeCreator if applicable
        BridgeName: string              //null,
        // Number of channels in the bridge
        BridgeNumChannels: number       //1,                  2
        //The video source mode for the bridge.
        BridgeVideoSourceMode?: "talker" | "single" | string   //'none',
        //If there is a video source for the bridge, the unique ID of the channel that is the video source.
        BridgeVideoSource?: string
        Channel: string                 //'SIP/107-00042237',   SIP/mtt-out-00042236
        //A numeric code for the channel's current state, related to ChannelStateDesc
        ChannelState: number            //6,
        ChannelStateDesc: "Down" |
          "Rsrvd" |
          "offHook" |
          "Diealing" |
          "Ring" |
          "Ringing" |
          "Up" |
          "Busy" |
          "Dialing Offhook" |
          "Pre-ring" |
          "Unknown" |
          string        //'Up',
        CallerIDNum: number             //null,          891******53
        CallerIDName: string            //null,
        ConnectedLineNum: number        //89******53,        null
        ConnectedLineName: string       //null,
        Language: string                //'ru',
        AccountCode: number             //'',
        Context: string                 //'callcenter',         menuivr
        Exten: number                   // null,
        Priority: number                // 1,                  8
        Uniqueid: number                //'1527245698.556770',  1527245675.556769
        //Uniqueid of the oldest channel associated with this channel.
        Linkedid: number                //'1527245675.556769'   1527245675.556769
        SwapUniqueid?: number
    }

    export interface I_BridgeDestroy {
        Event: string
        BridgeUniqueid: string
        BridgeType: string
        BridgeTechnology: string
        // Entity that created the bridge if applicable
        BridgeCreator: string
        //Name used to refer to the bridge by its BridgeCreator if applicable
        BridgeName: string
        BridgeNumChannels: number
        //The video source mode for the bridge.
        BridgeVideoSourceMode?: "talker" | "single" | string   //'none',
        //If there is a video source for the bridge, the unique ID of the channel that is the video source.
        BridgeVideoSource?: string
    }

    export interface I_BridgeMerge {
        Event: string
        ToBridgeUniqueid: string
        ToBridgeType: string
        ToBridgeTechnology: string
        //Entity that created the bridge if applicable
        ToBridgeCreator: string
        //Name used to refer to the bridge by its BridgeCreator if applicable
        ToBridgeName: string
        //Number of channels in the bridge
        ToBridgeNumChannels: number
        ToBridgeVideoSourceMode?: string
        ToBridgeVideoSource?: string
        FromBridgeUniqueid: string
        FromBridgeType: string
        FromBridgeTechnology: string
        FromBridgeCreator: string
        FromBridgeName: string
        FromBridgeNumChannels: number
        FromBridgeVideoSourceMode?: string
        FromBridgeVideoSource?: string
    }

    export interface I_BridgeInfoComplete {
        Event: string
        BridgeUniqueid: string
        BridgeType: string
        BridgeTechnology: string
        //Entity that created the bridge if applicable
        BridgeCreator: string
        //Name used to refer to the bridge by its BridgeCreator if applicable
        BridgeName: string
        //Number of channels in the bridge
        BridgeNumChannels: number
        BridgeVideoSourceMode?: string
        BridgeVideoSource?: string
    }

    export interface I_BridgeInfoChannel {
        Event: string
        Channel: string                 //'SIP/107-00042237',   SIP/mtt-out-00042236
        //A numeric code for the channel's current state, related to ChannelStateDesc
        ChannelState: number            //6,
        ChannelStateDesc: "Down" |
          "Rsrvd" |
          "offHook" |
          "Diealing" |
          "Ring" |
          "Ringing" |
          "Up" |
          "Busy" |
          "Dialing Offhook" |
          "Pre-ring" |
          "Unknown" |
          string        //'Up',
        CallerIDNum: number             //null,          89******353
        CallerIDName: string            //null,
        ConnectedLineNum: number        //89******353,        null
        ConnectedLineName: string       //null,
        Language: string                //'ru',
        AccountCode: number             //'',
        Context: string                 //'callcenter',         menuivr
        Exten: number                   // null,
        Priority: number                // 1,                  8
        Uniqueid: number                //'1527245698.556770',  1527245675.556769
        //Uniqueid of the oldest channel associated with this channel.
        Linkedid: number                //'1527245675.556769'   1527245675.556769
    }


    export interface I_BridgeListComplete {
        Event: string						// BridgeListComplete
        ActionID: string | number,			// 1528887557034
        EventList: 'Complete' | string,  	// Complete
        ListItems: number					// 2
    }

    export interface I_BridgeListItem {
        Event: string 					//'BridgeListItem',
        ActionID: string | number 		//'1528887557034',
        BridgeUniqueid: string 			//'13c53335-7c92-41e0-86f5-923c71fae6ad',
        BridgeType: string 				// 'basic',
        BridgeTechnology: string 		//'simple_bridge',
        BridgeCreator: string 			//null,
        BridgeName: string 				//null,
        BridgeNumChannels: number 		//2,
        BridgeVideoSourceMode?: string 	//'none',
    }


    /**
     * Core interfaces
     *
     */
        //Raised in response to a CoreShowChannels command.
    export interface I_CoreShowChannel {
        Event: string
        ActionID: number | string
        Channel: string
        ChannelState: number
        ChannelStateDesc: string
        CallerIDNum: number
        CallerIDName: string
        ConnectedLineNum: number
        ConnectedLineName: string
        AccountCode: number
        Context: string
        Exten: number
        Priority: number
        Uniqueid: number
        Linkedid: number
        BridgeId: string
        Application: string
        ApplicationData: string
        //The amount of time the channel has existed
        Duration: string
    }

    //Raised at the end of the CoreShowChannel list produced by the CoreShowChannels command.
    export interface I_CoreShowChannelsComplete {
        Event: string
        // ActionID for this transaction. Will be returned.
        ActionID: number | string
        //Conveys the status of the command reponse list
        EventList: string
        //The total number of list items produced
        ListItems: number
    }


    /**
     * Dial event interfaces
     *
     */
    export interface I_DialBegin {
        Privilege: string               //'call,all'
        Channel: string                 //'IAX2/aster-17127'
        ChannelState: number            // 6
        ChannelStateDesc: string        //'Up'
        CallerIDNum: number             // 89*****4387
        CallerIDName: string            // null,
        ConnectedLineNum: number        // 110
        ConnectedLineName: string       //'110 test'
        Language: string                //'en'
        AccountCode: number             // null
        Context: string                 // 'callcenter'
        Exten: number                   // 1877
        Priority: number                // 3
        Uniqueid: number                // 1528262325.580184
        Linkedid: number                // 1528262325.580183

        DestChannel: string             //'IAX2/aster-25872'
        DestChannelState: number        // 5
        DestChannelStateDesc: string    //'Ringing'
        DestCallerIDNum: number        // 1877
        DestCallerIDName: string        //'110 test'
        DestConnectedLineNum: number    // 89*****4387
        DestConnectedLineName: string   // null
        DestLanguage: string            //'en'
        DestAccountCode: number         // null
        DestContext: string             //'callcenter'
        DestExten: number               // 1877
        DestPriority: number            // 1
        DestUniqueid: number            // 1528262348.580187
        DestLinkedid: number            // 1528262325.580183'
        DialStatus: string              //'RINGING'
    }

    export interface I_DialEnd {
        Privilege: string               //'call,all'
        Channel: string                 //'IAX2/aster-17127'
        ChannelState: number            // 6
        ChannelStateDesc: string        //'Up'
        CallerIDNum: number             // 89*****4387
        CallerIDName: string            // null,
        ConnectedLineNum: number        // 110
        ConnectedLineName: string       //'110 test'
        Language: string                //'en'
        AccountCode: number             // null
        Context: string                 // 'callcenter'
        Exten: number                   // 1877
        Priority: number                // 3
        Uniqueid: number                // 1528262325.580184
        Linkedid: number                // 1528262325.580183

        DestChannel: string             //'IAX2/aster-25872'
        DestChannelState: number        // 5
        DestChannelStateDesc: string    //'Ringing'
        DestCallerIDNum: number        // 1877
        DestCallerIDName: string        //'110 test'
        DestConnectedLineNum: number    // 89*****4387
        DestConnectedLineName: string   // null
        DestLanguage: string            //'en'
        DestAccountCode: number         // null
        DestContext: string             //'callcenter'
        DestExten: number               // 1877
        DestPriority: number            // 1
        DestUniqueid: number            // 1528262348.580187
        DestLinkedid: number            // 1528262325.580183'
        DialStatus: string              //'RINGING'
    }

    export interface I_DialState {
        Privilege: string               //'call,all'
        Channel: string                 //'IAX2/aster-17127'
        ChannelState: number            // 6
        ChannelStateDesc: string        //'Up'
        CallerIDNum: number             // 89*****4387
        CallerIDName: string            // null,
        ConnectedLineNum: number        // 110
        ConnectedLineName: string       //'110 test'
        Language: string                //'en'
        AccountCode: number             // null
        Context: string                 // 'callcenter'
        Exten: number                   // 1877
        Priority: number                // 3
        Uniqueid: number                // 1528262325.580184
        Linkedid: number                // 1528262325.580183

        DestChannel: string             //'IAX2/aster-25872'
        DestChannelState: number        // 5
        DestChannelStateDesc: string    //'Ringing'
        DestCallerIDNum: number        // 1877
        DestCallerIDName: string        //'110 test'
        DestConnectedLineNum: number    // 89*****4387
        DestConnectedLineName: string   // null
        DestLanguage: string            //'en'
        DestAccountCode: number         // null
        DestContext: string             //'callcenter'
        DestExten: number               // 1877
        DestPriority: number            // 1
        DestUniqueid: number            // 1528262348.580187
        DestLinkedid: number            // 1528262325.580183'
        DialStatus: string              //'RINGING'
    }

    /**
     * DTMF event interfaces
     *
     */
    export interface I_DTMFBegin {
        Event: string
        Channel: string
        ChannelState: string
        ChannelStateDesc: string
        CallerIDNum: number
        CallerIDName: string
        ConnectedLineNum: number
        ConnectedLineName: string
        AccountCode: number
        Context: string
        Exten: number
        Priority: number
        Uniqueid: number
        Linkedid: number
        //DTMF digit received or transmitted (0-9, A-E, # or *
        Digit: string
        Direction: "Received" | "Sent"
    }

    export interface I_DTMFEnd {
        Event: string
        Channel: string
        ChannelState: string
        ChannelStateDesc: string
        CallerIDNum: number
        CallerIDName: string
        ConnectedLineNum: number
        ConnectedLineName: string
        AccountCode: number
        Context: string
        Exten: number
        Priority: number
        Uniqueid: number
        Linkedid: number
        //DTMF digit received or transmitted (0-9, A-E, # or *
        Digit: string
        //Duration (in milliseconds) DTMF was sent/received
        DurationMs: number
        Direction: "Received" | "Sent"
    }

    /**
     * Hangup event interfaces
     *
     */
    export interface I_HangupRequest {
        Event: string               //'HangupRequest',
        Privilege: string           //'call,all',
        Channel: string             //'IAX2/aster-25439',
        ChannelState: number        // 5
        ChannelStateDesc: string    //'Ringing',
        CallerIDNum: number         // 89*****4387
        CallerIDName: string        // null
        ConnectedLineNum: number    // 110
        ConnectedLineName: string   //'110 test',
        Language: string            //'en',
        AccountCode: number         // null,
        Context: string             //'callcenter',
        Exten: number               // 89*****4387
        Priority: number            // 1
        Uniqueid: number            // 1527245623.556767
        Linkedid: number            // 1527245623.556766
    }

    export interface I_Hangup {
        Event: string               //'Hangup',
        Privilege: string           //'call,all',
        Channel: string             //'IAX2/aster-25439',
        ChannelState: number        // 5
        ChannelStateDesc: string    //'Ringing',
        CallerIDNum: number         // 89*****4387
        CallerIDName: string        // null
        ConnectedLineNum: number    // 110
        ConnectedLineName: string   //'110 test',
        Language: string            //'en',
        AccountCode: number         // null,
        Context: string             //'callcenter',
        Exten: number               // 89*****4387
        Priority: number            // 1
        Uniqueid: number            // 1527245623.556767
        Linkedid: number            // 1527245623.556766
    }

    export interface I_DualHangup {
        hangup: I_Hangup
        hangupRequest: I_HangupRequest
    }


    /**
     * NewChannel|Extend|State|ConnectedLine event interfaces
     *
     */
        //Raised when a new channel is created.
    export interface I_NewChannel {
        Event: string               //'Newchannel',
        Privilege: string           //'call,all',
        Channel: string             //'SIP/110-00042242',
        ChannelState: number        // 0
        ChannelStateDesc: string    //'Down',
        CallerIDNum: number         // 110
        CallerIDName: string        //'110 test',
        ConnectedLineNum: number    // null
        ConnectedLineName: string   // null',
        Language: string            //'en',
        AccountCode: number         // null
        Context: string             //'callcenter',
        Exten: number               // 89*****4387
        Priority: number            // 1
        Uniqueid: number            // 1527247326.556790
        Linkedid: number            // 1527247326.556790
    }

    //Raised when a channel's state changes.
    export interface I_NewState {
        Event: string               //'Newchannel',
        Privilege: string           //'call,all',
        Channel: string             //'SIP/110-00042242',
        ChannelState: number        // 0
        ChannelStateDesc: string    //'Down',
        CallerIDNum: number         // 110
        CallerIDName: string        //'110 test',
        ConnectedLineNum: number    // null
        ConnectedLineName: string   // null',
        Language: string            //'en',
        AccountCode: number         // null
        Context: string             //'callcenter',
        Exten: number               // 89*****4387
        Priority: number            // 1
        Uniqueid: number            // 1527247326.556790
        Linkedid: number            // 1527247326.556790
    }

    //Raised when a channel's connected line information is changed.
    export interface I_NewConnectedLine {
        Event: string               //'NewConnectedLine',
        Privilege: string           //'call,all',
        Channel: string             //'SIP/110-00042242',
        ChannelState: number        // 0
        ChannelStateDesc: string    //'Down',
        CallerIDNum: number         // 110
        CallerIDName: string        //'110 test',
        ConnectedLineNum: number    // null
        ConnectedLineName: string   // null',
        Language: string            //'en',
        AccountCode: number         // null
        Context: string             //'callcenter',
        Exten: number               // 89*****4387
        Priority: number            // 1
        Uniqueid: number            // 1527247326.556790
        Linkedid: number            // 1527247326.556790
    }

    //Raised when a channel enters a new context, extension, priority.
    export interface I_NewExten {
        Event: string               //'NewConnectedLine',
        Channel: string             //'SIP/110-00042242',
        ChannelState: number        // 0
        ChannelStateDesc: string    //'Down',
        CallerIDNum: number         // 110
        CallerIDName: string        //'110 test',
        ConnectedLineNum: number    // null
        ConnectedLineName: string   // null',
        AccountCode: number         // null
        Context: string             //'callcenter',
        Exten: number               // 89*****4387
        Priority: number            // 1
        Uniqueid: number            // 1527247326.556790
        Linkedid: number            // 1527247326.556790
        // Deprecated in 12, but kept for backward compatability. Please use 'Exten' instead.
        Extension: string
        //The application about to be executed
        Application: string
        //The data to be passed to the application.
        AppData: string
    }

    /**
     * Originate event interface
     *
     */
    export interface I_OriginateResponse {
        Event: "OriginateResponse"
        ActionID?: number | string
        Response: string
        Channel: string
        Context: string
        Exten: number
        Application: string
        Data: string
        Reason: string
        Uniqueid: number
        CallerIDNum: number
        CallerIDName: string
    }

    /**
     * Queue event interfaces
     *
     */
        //Response by QueueStatus action
        //Вызывается для каждого оператора очереди
    export interface I_QueueMember {
        Event: string
        //The name of the queue.
        Queue: string
        //The name of the queue member.
        MemberName: string
        //The queue member's channel technology or location.
        Interface: string
        //Channel technology or location from which to read device state changes.
        StateInterface: string

        Membership: "dynamic" | "realtime" | "static" | string

        //The penalty associated with the queue member.
        Penalty: number
        //The number of calls this queue member has serviced.
        CallsTaken: number
        //The time this member last took a call, expressed in seconds since 00:00, Jan 1, 1970 UTC.
        LastCall: number
        //The time when started last paused the queue member.
        LastPause: number
        // Set to 1 if member is in call. Set to 0 after LastCall time is updated.
        InCall: 0 | 1
        //The numeric device state status of the queue member.
        Status: 0 // AST_DEVICE_UNKNOWN
          | 1 // AST_DEVICE_NOT_INUSE
          | 2 // AST_DEVICE_INUSE
          | 3 // AST_DEVICE_BUSY
          | 4 // AST_DEVICE_INVALID
          | 5 // AST_DEVICE_UNAVAILABLE
          | 6 // AST_DEVICE_RINGING
          | 7 // AST_DEVICE_RINGINUSE
          | 8 // AST_DEVICE_ONHOLD

        Paused: 0 | 1
        //If set when paused, the reason the queue member was paused.
        PausedReason: string
        Ringinuse: 0 | 1
    }

    //Raised when a member is added to the queue.
    export interface I_QueueMemberAdded {
        Event: "QueueMemberAdded"
        Queue: string
        MemberName: string
        Interface: string
        StateInterface: string
        Membership: "dynamic" | "realtime" | "static" | string
        Penalty: number
        CallsTaken: number
        LastCall: number
        Status: number
        Paused: boolean
        Ringinuse: 0 | 1
    }

    //Raised when a member is removed from the queue.
    export interface I_QueueMemberRemoved {
        Event: "QueueMemberRemoved"
        Queue: string
        MemberName: string
        Interface: string
        StateInterface: string
        Membership: "dynamic" | "realtime" | "static" | string
        Penalty: number
        CallsTaken: number
        LastCall: number
        Status: number
        Paused: boolean
        Ringinuse: 0 | 1
    }

    //Raised when a member's penalty is changed.
    export interface I_QueueMemberPenalty {
        Event: "QueueMemberPenalty"
        Queue: string
        MemberN