Options
All
  • Public
  • Public/Protected
  • All
Menu

@types/ari-client

Index

Interfaces

Type aliases

Functions

Type aliases

APILoadErrorEventType

APILoadErrorEventType: "APILoadError"

AnyEventType

ApplicationMoveFailedEventType

ApplicationMoveFailedEventType: "ApplicationMoveFailed"

ApplicationReplacedEventType

ApplicationReplacedEventType: "ApplicationReplaced"

BridgeAttendedTransferEventType

BridgeAttendedTransferEventType: "BridgeAttendedTransfer"

BridgeBlindTransferEventType

BridgeBlindTransferEventType: "BridgeBlindTransfer"

BridgeCreatedEventType

BridgeCreatedEventType: "BridgeCreated"

BridgeDestroyedEventType

BridgeDestroyedEventType: "BridgeDestroyed"

BridgeMergedEventType

BridgeMergedEventType: "BridgeMerged"

BridgeVideoSourceChangedEventType

BridgeVideoSourceChangedEventType: "BridgeVideoSourceChanged"

ChannelCallerIdEventType

ChannelCallerIdEventType: "ChannelCallerId"

ChannelConnectedLineEventType

ChannelConnectedLineEventType: "ChannelConnectedLine"

ChannelCreatedEventType

ChannelCreatedEventType: "ChannelCreated"

ChannelDestroyedEventType

ChannelDestroyedEventType: "ChannelDestroyed"

ChannelDialplanEventType

ChannelDialplanEventType: "ChannelDialplan"

ChannelDtmfReceivedEventType

ChannelDtmfReceivedEventType: "ChannelDtmfReceived"

ChannelEnteredBridgeEventType

ChannelEnteredBridgeEventType: "ChannelEnteredBridge"

ChannelHangupRequestEventType

ChannelHangupRequestEventType: "ChannelHangupRequest"

ChannelHoldEventType

ChannelHoldEventType: "ChannelHold"

ChannelLeftBridgeEventType

ChannelLeftBridgeEventType: "ChannelLeftBridge"

ChannelStateChangeEventType

ChannelStateChangeEventType: "ChannelStateChange"

ChannelTalkingFinishedEventType

ChannelTalkingFinishedEventType: "ChannelTalkingFinished"

ChannelTalkingStartedEventType

ChannelTalkingStartedEventType: "ChannelTalkingStarted"

ChannelUnholdEventType

ChannelUnholdEventType: "ChannelUnhold"

ChannelUsereventEventType

ChannelUsereventEventType: "ChannelUserevent"

ChannelVarsetEventType

ChannelVarsetEventType: "ChannelVarset"

ContactInfoEventType

ContactInfoEventType: "ContactInfo"

ContactStatusChangeEventType

ContactStatusChangeEventType: "ContactStatusChange"

DeviceStateChangedEventType

DeviceStateChangedEventType: "DeviceStateChanged"

DialEventType

DialEventType: "Dial"

EndpointStateChangeEventType

EndpointStateChangeEventType: "EndpointStateChange"

EventEventType

EventEventType: "Event"

EventsEventType

EventsEventType: "Events"

MessageEventType

MessageEventType: "Message"

MissingParamsEventType

MissingParamsEventType: "MissingParams"

PeerEventType

PeerEventType: "Peer"

PeerStatusChangeEventType

PeerStatusChangeEventType: "PeerStatusChange"

PlaybackContinuingEventType

PlaybackContinuingEventType: "PlaybackContinuing"

PlaybackFinishedEventType

PlaybackFinishedEventType: "PlaybackFinished"

PlaybackStartedEventType

PlaybackStartedEventType: "PlaybackStarted"

RecordingFailedEventType

RecordingFailedEventType: "RecordingFailed"

RecordingFinishedEventType

RecordingFinishedEventType: "RecordingFinished"

RecordingStartedEventType

RecordingStartedEventType: "RecordingStarted"

StasisEndEventType

StasisEndEventType: "StasisEnd"

StasisStartEventType

StasisStartEventType: "StasisStart"

TextMessageReceivedEventType

TextMessageReceivedEventType: "TextMessageReceived"

Functions

connect

  • connect(baseUrl: string, user: string, pass: string, callback?: (err: Error, client: Client) => void): Promise<Client>
  • Create an instance of Client using the provided connection options and call the provided callback once the API has been attached to the Client.

    Parameters

    • baseUrl: string

      The URL to the ARI instance.

    • user: string

      The username for the ARI instance.

    • pass: string

      The password for the ARI instance.

    • Optional callback: (err: Error, client: Client) => void
        • (err: Error, client: Client): void
        • Parameters

          Returns void

    Returns Promise<Client>

Generated using TypeDoc