Channel | @types/ari-client

Hierarchy

Resource
- Channel

Index

Properties

Methods

Properties

accountcode

accountcode: string

Accountcode.

caller

caller: CallerID

Caller.

Optional channelvars

channelvars: IndexableObject

Channel variables.

connected

connected: CallerID

Connected.

creationtime

creationtime: Date

Timestamp when channel was created.

dialplan

dialplan: DialplanCEP

Current location in the dialplan.

id

id: string

Unique identifier of the channel. This is the same as the Uniqueid field in AMI.

language

language: string

The default spoken language.

name

name: string

Name of the channel (i.e. SIP/foo-0000a7e3).

state

state: string

State.

Methods

addListener

addListener(event: "Message", callback: (event: Message, instances: Message) => void): void
addListener(event: "MissingParams", callback: (event: MissingParams, instances: MissingParams) => void): void
addListener(event: "Event", callback: (event: Event, instances: Event) => void): void
addListener(event: "ContactInfo", callback: (event: ContactInfo, instances: ContactInfo) => void): void
addListener(event: "Peer", callback: (event: Peer, instances: Peer) => void): void
addListener(event: "DeviceStateChanged", callback: (event: DeviceStateChanged, devicestate: DeviceState) => void): void
addListener(event: "PlaybackStarted", callback: (event: PlaybackStarted, playback: Playback) => void): void
addListener(event: "PlaybackContinuing", callback: (event: PlaybackContinuing, playback: Playback) => void): void
addListener(event: "PlaybackFinished", callback: (event: PlaybackFinished, playback: Playback) => void): void
addListener(event: "RecordingStarted", callback: (event: RecordingStarted, liverecording: LiveRecording) => void): void
addListener(event: "RecordingFinished", callback: (event: RecordingFinished, liverecording: LiveRecording) => void): void
addListener(event: "RecordingFailed", callback: (event: RecordingFailed, liverecording: LiveRecording) => void): void
addListener(event: "ApplicationMoveFailed", callback: (event: ApplicationMoveFailed, channel: Channel) => void): void
addListener(event: "ApplicationReplaced", callback: (event: Event) => void): void
addListener(event: "BridgeCreated", callback: (event: BridgeCreated, bridge: Bridge) => void): void
addListener(event: "BridgeDestroyed", callback: (event: BridgeDestroyed, bridge: Bridge) => void): void
addListener(event: "BridgeMerged", callback: (event: BridgeMerged, bridge: Bridge) => void): void
addListener(event: "BridgeVideoSourceChanged", callback: (event: BridgeVideoSourceChanged, bridge: Bridge) => void): void
addListener(event: "BridgeBlindTransfer", callback: (event: BridgeBlindTransfer, instances: BridgeBlindTransfer) => void): void
addListener(event: "BridgeAttendedTransfer", callback: (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer) => void): void
addListener(event: "ChannelCreated", callback: (event: ChannelCreated, channel: Channel) => void): void
addListener(event: "ChannelDestroyed", callback: (event: ChannelDestroyed, channel: Channel) => void): void
addListener(event: "ChannelEnteredBridge", callback: (event: ChannelEnteredBridge, instances: ChannelEnteredBridge) => void): void
addListener(event: "ChannelLeftBridge", callback: (event: ChannelLeftBridge, instances: ChannelLeftBridge) => void): void
addListener(event: "ChannelStateChange", callback: (event: ChannelStateChange, channel: Channel) => void): void
addListener(event: "ChannelDtmfReceived", callback: (event: ChannelDtmfReceived, channel: Channel) => void): void
addListener(event: "ChannelDialplan", callback: (event: ChannelDialplan, channel: Channel) => void): void
addListener(event: "ChannelCallerId", callback: (event: ChannelCallerId, channel: Channel) => void): void
addListener(event: "ChannelUserevent", callback: (event: ChannelUserevent, instances: ChannelUserevent) => void): void
addListener(event: "ChannelHangupRequest", callback: (event: ChannelHangupRequest, channel: Channel) => void): void
addListener(event: "ChannelVarset", callback: (event: ChannelVarset, channel: Channel) => void): void
addListener(event: "ChannelHold", callback: (event: ChannelHold, channel: Channel) => void): void
addListener(event: "ChannelUnhold", callback: (event: ChannelUnhold, channel: Channel) => void): void
addListener(event: "ChannelTalkingStarted", callback: (event: ChannelTalkingStarted, channel: Channel) => void): void
addListener(event: "ChannelTalkingFinished", callback: (event: ChannelTalkingFinished, channel: Channel) => void): void
addListener(event: "ContactStatusChange", callback: (event: ContactStatusChange, endpoint: Endpoint) => void): void
addListener(event: "PeerStatusChange", callback: (event: PeerStatusChange, endpoint: Endpoint) => void): void
addListener(event: "EndpointStateChange", callback: (event: EndpointStateChange, endpoint: Endpoint) => void): void
addListener(event: "Dial", callback: (event: Dial, channel: Channel) => void): void
addListener(event: "StasisEnd", callback: (event: StasisEnd, channel: Channel) => void): void
addListener(event: "StasisStart", callback: (event: StasisStart, channel: Channel) => void): void
addListener(event: "TextMessageReceived", callback: (event: TextMessageReceived, endpoint: Endpoint) => void): void
addListener(event: "ChannelConnectedLine", callback: (event: ChannelConnectedLine, channel: Channel) => void): void

Inherited from Resource.addListener
- Defined in index.d.ts:1399
Base type for errors and events.

Parameters
- event: "Message"
- callback: (event: Message, instances: Message) => void
  - - (event: Message, instances: Message): void
    - Parameters
      - event: Message
      - instances: Message
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1404
Error event sent when required params are missing.

Parameters
- event: "MissingParams"
- callback: (event: MissingParams, instances: MissingParams) => void
  - - (event: MissingParams, instances: MissingParams): void
    - Parameters
      - event: MissingParams
      - instances: MissingParams
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1412
Base type for asynchronous events from Asterisk.

Parameters
- event: "Event"
- callback: (event: Event, instances: Event) => void
  - - (event: Event, instances: Event): void
    - Parameters
      - event: Event
      - instances: Event
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1417
Detailed information about a contact on an endpoint.

Parameters
- event: "ContactInfo"
- callback: (event: ContactInfo, instances: ContactInfo) => void
  - - (event: ContactInfo, instances: ContactInfo): void
    - Parameters
      - event: ContactInfo
      - instances: ContactInfo
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1422
Detailed information about a remote peer that communicates with Asterisk.

Parameters
- event: "Peer"
- callback: (event: Peer, instances: Peer) => void
  - - (event: Peer, instances: Peer): void
    - Parameters
      - event: Peer
      - instances: Peer
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1427
Notification that a device state has changed.

Parameters
- event: "DeviceStateChanged"
- callback: (event: DeviceStateChanged, devicestate: DeviceState) => void
  - - (event: DeviceStateChanged, devicestate: DeviceState): void
    - Parameters
      - event: DeviceStateChanged
      - devicestate: DeviceState
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1435
Event showing the start of a media playback operation.

Parameters
- event: "PlaybackStarted"
- callback: (event: PlaybackStarted, playback: Playback) => void
  - - (event: PlaybackStarted, playback: Playback): void
    - Parameters
      - event: PlaybackStarted
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1440
Event showing the continuation of a media playback operation from one media URI to the next in the list.

Parameters
- event: "PlaybackContinuing"
- callback: (event: PlaybackContinuing, playback: Playback) => void
  - - (event: PlaybackContinuing, playback: Playback): void
    - Parameters
      - event: PlaybackContinuing
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1448
Event showing the completion of a media playback operation.

Parameters
- event: "PlaybackFinished"
- callback: (event: PlaybackFinished, playback: Playback) => void
  - - (event: PlaybackFinished, playback: Playback): void
    - Parameters
      - event: PlaybackFinished
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1456
Event showing the start of a recording operation.

Parameters
- event: "RecordingStarted"
- callback: (event: RecordingStarted, liverecording: LiveRecording) => void
  - - (event: RecordingStarted, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingStarted
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1464
Event showing the completion of a recording operation.

Parameters
- event: "RecordingFinished"
- callback: (event: RecordingFinished, liverecording: LiveRecording) => void
  - - (event: RecordingFinished, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingFinished
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1472
Event showing failure of a recording operation.

Parameters
- event: "RecordingFailed"
- callback: (event: RecordingFailed, liverecording: LiveRecording) => void
  - - (event: RecordingFailed, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingFailed
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1480
Notification that trying to move a channel to another Stasis application failed.

Parameters
- event: "ApplicationMoveFailed"
- callback: (event: ApplicationMoveFailed, channel: Channel) => void
  - - (event: ApplicationMoveFailed, channel: Channel): void
    - Parameters
      - event: ApplicationMoveFailed
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1489
Notification that another WebSocket has taken over for an application. An application may only be subscribed to by a single WebSocket at a time. If multiple WebSockets attempt to subscribe to the same application, the newer WebSocket wins, and the older one receives this event.

Parameters
- event: "ApplicationReplaced"
- callback: (event: Event) => void
  - - (event: Event): void
    - Parameters
      - event: Event
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1494
Notification that a bridge has been created.

Parameters
- event: "BridgeCreated"
- callback: (event: BridgeCreated, bridge: Bridge) => void
  - - (event: BridgeCreated, bridge: Bridge): void
    - Parameters
      - event: BridgeCreated
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1499
Notification that a bridge has been destroyed.

Parameters
- event: "BridgeDestroyed"
- callback: (event: BridgeDestroyed, bridge: Bridge) => void
  - - (event: BridgeDestroyed, bridge: Bridge): void
    - Parameters
      - event: BridgeDestroyed
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1504
Notification that one bridge has merged into another.

Parameters
- event: "BridgeMerged"
- callback: (event: BridgeMerged, bridge: Bridge) => void
  - - (event: BridgeMerged, bridge: Bridge): void
    - Parameters
      - event: BridgeMerged
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1509
Notification that the source of video in a bridge has changed.

Parameters
- event: "BridgeVideoSourceChanged"
- callback: (event: BridgeVideoSourceChanged, bridge: Bridge) => void
  - - (event: BridgeVideoSourceChanged, bridge: Bridge): void
    - Parameters
      - event: BridgeVideoSourceChanged
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1517
Notification that a blind transfer has occurred.

Parameters
- event: "BridgeBlindTransfer"
- callback: (event: BridgeBlindTransfer, instances: BridgeBlindTransfer) => void
  - - (event: BridgeBlindTransfer, instances: BridgeBlindTransfer): void
    - Parameters
      - event: BridgeBlindTransfer
      - instances: BridgeBlindTransfer
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1525
Notification that an attended transfer has occurred.

Parameters
- event: "BridgeAttendedTransfer"
- callback: (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer) => void
  - - (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer): void
    - Parameters
      - event: BridgeAttendedTransfer
      - instances: BridgeAttendedTransfer
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1533
Notification that a channel has been created.

Parameters
- event: "ChannelCreated"
- callback: (event: ChannelCreated, channel: Channel) => void
  - - (event: ChannelCreated, channel: Channel): void
    - Parameters
      - event: ChannelCreated
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1538
Notification that a channel has been destroyed.

Parameters
- event: "ChannelDestroyed"
- callback: (event: ChannelDestroyed, channel: Channel) => void
  - - (event: ChannelDestroyed, channel: Channel): void
    - Parameters
      - event: ChannelDestroyed
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1543
Notification that a channel has entered a bridge.

Parameters
- event: "ChannelEnteredBridge"
- callback: (event: ChannelEnteredBridge, instances: ChannelEnteredBridge) => void
  - - (event: ChannelEnteredBridge, instances: ChannelEnteredBridge): void
    - Parameters
      - event: ChannelEnteredBridge
      - instances: ChannelEnteredBridge
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1551
Notification that a channel has left a bridge.

Parameters
- event: "ChannelLeftBridge"
- callback: (event: ChannelLeftBridge, instances: ChannelLeftBridge) => void
  - - (event: ChannelLeftBridge, instances: ChannelLeftBridge): void
    - Parameters
      - event: ChannelLeftBridge
      - instances: ChannelLeftBridge
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1559
Notification of a channels state change.

Parameters
- event: "ChannelStateChange"
- callback: (event: ChannelStateChange, channel: Channel) => void
  - - (event: ChannelStateChange, channel: Channel): void
    - Parameters
      - event: ChannelStateChange
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1567
DTMF received on a channel. This event is sent when the DTMF ends. There is no notification about the start of DTMF.

Parameters
- event: "ChannelDtmfReceived"
- callback: (event: ChannelDtmfReceived, channel: Channel) => void
  - - (event: ChannelDtmfReceived, channel: Channel): void
    - Parameters
      - event: ChannelDtmfReceived
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1575
Channel changed location in the dialplan.

Parameters
- event: "ChannelDialplan"
- callback: (event: ChannelDialplan, channel: Channel) => void
  - - (event: ChannelDialplan, channel: Channel): void
    - Parameters
      - event: ChannelDialplan
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1580
Channel changed Caller ID.

Parameters
- event: "ChannelCallerId"
- callback: (event: ChannelCallerId, channel: Channel) => void
  - - (event: ChannelCallerId, channel: Channel): void
    - Parameters
      - event: ChannelCallerId
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1585
User-generated event with additional user-defined fields in the object.

Parameters
- event: "ChannelUserevent"
- callback: (event: ChannelUserevent, instances: ChannelUserevent) => void
  - - (event: ChannelUserevent, instances: ChannelUserevent): void
    - Parameters
      - event: ChannelUserevent
      - instances: ChannelUserevent
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1593
A hangup was requested on the channel.

Parameters
- event: "ChannelHangupRequest"
- callback: (event: ChannelHangupRequest, channel: Channel) => void
  - - (event: ChannelHangupRequest, channel: Channel): void
    - Parameters
      - event: ChannelHangupRequest
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1601
Channel variable changed.

Parameters
- event: "ChannelVarset"
- callback: (event: ChannelVarset, channel: Channel) => void
  - - (event: ChannelVarset, channel: Channel): void
    - Parameters
      - event: ChannelVarset
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1606
A channel initiated a media hold.

Parameters
- event: "ChannelHold"
- callback: (event: ChannelHold, channel: Channel) => void
  - - (event: ChannelHold, channel: Channel): void
    - Parameters
      - event: ChannelHold
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1611
A channel initiated a media unhold.

Parameters
- event: "ChannelUnhold"
- callback: (event: ChannelUnhold, channel: Channel) => void
  - - (event: ChannelUnhold, channel: Channel): void
    - Parameters
      - event: ChannelUnhold
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1616
Talking was detected on the channel.

Parameters
- event: "ChannelTalkingStarted"
- callback: (event: ChannelTalkingStarted, channel: Channel) => void
  - - (event: ChannelTalkingStarted, channel: Channel): void
    - Parameters
      - event: ChannelTalkingStarted
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1624
Talking is no longer detected on the channel.

Parameters
- event: "ChannelTalkingFinished"
- callback: (event: ChannelTalkingFinished, channel: Channel) => void
  - - (event: ChannelTalkingFinished, channel: Channel): void
    - Parameters
      - event: ChannelTalkingFinished
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1632
The state of a contact on an endpoint has changed.

Parameters
- event: "ContactStatusChange"
- callback: (event: ContactStatusChange, endpoint: Endpoint) => void
  - - (event: ContactStatusChange, endpoint: Endpoint): void
    - Parameters
      - event: ContactStatusChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1640
The state of a peer associated with an endpoint has changed.

Parameters
- event: "PeerStatusChange"
- callback: (event: PeerStatusChange, endpoint: Endpoint) => void
  - - (event: PeerStatusChange, endpoint: Endpoint): void
    - Parameters
      - event: PeerStatusChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1648
Endpoint state changed.

Parameters
- event: "EndpointStateChange"
- callback: (event: EndpointStateChange, endpoint: Endpoint) => void
  - - (event: EndpointStateChange, endpoint: Endpoint): void
    - Parameters
      - event: EndpointStateChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1656
Dialing state has changed.

Parameters
- event: "Dial"
- callback: (event: Dial, channel: Channel) => void
  - - (event: Dial, channel: Channel): void
    - Parameters
      - event: Dial
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1661
Notification that a channel has left a Stasis application.

Parameters
- event: "StasisEnd"
- callback: (event: StasisEnd, channel: Channel) => void
  - - (event: StasisEnd, channel: Channel): void
    - Parameters
      - event: StasisEnd
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1666
Notification that a channel has entered a Stasis application.

Parameters
- event: "StasisStart"
- callback: (event: StasisStart, channel: Channel) => void
  - - (event: StasisStart, channel: Channel): void
    - Parameters
      - event: StasisStart
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1671
A text message was received from an endpoint.

Parameters
- event: "TextMessageReceived"
- callback: (event: TextMessageReceived, endpoint: Endpoint) => void
  - - (event: TextMessageReceived, endpoint: Endpoint): void
    - Parameters
      - event: TextMessageReceived
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1679
Channel changed Connected Line.

Parameters
- event: "ChannelConnectedLine"
- callback: (event: ChannelConnectedLine, channel: Channel) => void
  - - (event: ChannelConnectedLine, channel: Channel): void
    - Parameters
      - event: ChannelConnectedLine
      - channel: Channel
      Returns void
Returns void

answer

answer(callback: (err: Error) => void): void
answer(): Promise<void>

- Defined in index.d.ts:4491
Answer a channel.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4496
Answer a channel.

Returns Promise<void>

continueInDialplan

continueInDialplan(params: { context?: string; extension?: string; label?: string; priority?: number }, callback: (err: Error) => void): void
continueInDialplan(callback: (err: Error) => void): void
continueInDialplan(params?: { context?: string; extension?: string; label?: string; priority?: number }): Promise<void>

- Defined in index.d.ts:4433
Exit application; continue execution in the dialplan.

Parameters
- params: { context?: string; extension?: string; label?: string; priority?: number }
  - Optional context?: string
  - Optional extension?: string
  - Optional label?: string
  - Optional priority?: number
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4441
Exit application; continue execution in the dialplan.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4451
Exit application; continue execution in the dialplan.

Parameters
- Optional params: { context?: string; extension?: string; label?: string; priority?: number }
  - Optional context?: string
  - Optional extension?: string
  - Optional label?: string
  - Optional priority?: number
Returns Promise<void>

create

create(params: { app: string; appArgs?: string; endpoint: string; formats?: string; originator?: string; otherChannelId?: string }, callback: (err: Error, channel: Channel) => void): void
create(params: { app: string; appArgs?: string; endpoint: string; formats?: string; originator?: string; otherChannelId?: string }): Promise<Channel>

- Defined in index.d.ts:4288
Create channel.

Parameters
- params: { app: string; appArgs?: string; endpoint: string; formats?: string; originator?: string; otherChannelId?: string }
  - app: string
    
    Stasis Application to place channel into.
  - Optional appArgs?: string
  - endpoint: string
    
    Endpoint for channel communication.
  - Optional formats?: string
  - Optional originator?: string
  - Optional otherChannelId?: string
- callback: (err: Error, channel: Channel) => void
  - - (err: Error, channel: Channel): void
    - Parameters
      - err: Error
      - channel: Channel
      Returns void
Returns void
- Defined in index.d.ts:4310
Create channel.

Parameters
- params: { app: string; appArgs?: string; endpoint: string; formats?: string; originator?: string; otherChannelId?: string }
  - app: string
    
    Stasis Application to place channel into.
  - Optional appArgs?: string
  - endpoint: string
    
    Endpoint for channel communication.
  - Optional formats?: string
  - Optional originator?: string
  - Optional otherChannelId?: string
Returns Promise<Channel>

dial

dial(params: { caller?: string; timeout?: number }, callback: (err: Error) => void): void
dial(callback: (err: Error) => void): void
dial(params?: { caller?: string; timeout?: number }): Promise<void>

- Defined in index.d.ts:4888
Dial a created channel.

Parameters
- params: { caller?: string; timeout?: number }
  - Optional caller?: string
  - Optional timeout?: number
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4893
Dial a created channel.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4901
Dial a created channel.

Parameters
- Optional params: { caller?: string; timeout?: number }
  - Optional caller?: string
  - Optional timeout?: number
Returns Promise<void>

externalMedia

externalMedia(params: { app: string; connection_type?: string; direction?: string; encapsulation?: string; external_host: string; format: string; transport?: string; variables?: Containers }, callback: (err: Error, channel: Channel) => void): void
externalMedia(params: { app: string; connection_type?: string; direction?: string; encapsulation?: string; external_host: string; format: string; transport?: string; variables?: Containers }): Promise<Channel>

- Defined in index.d.ts:4927
Start an External Media session. Create a channel to an External Media source/sink.

Parameters
- params: { app: string; connection_type?: string; direction?: string; encapsulation?: string; external_host: string; format: string; transport?: string; variables?: Containers }
  - app: string
    
    Stasis Application to place channel into.
  - Optional connection_type?: string
  - Optional direction?: string
  - Optional encapsulation?: string
  - external_host: string
    
    Hostname/ip:port of external host.
  - format: string
    
    Format to encode audio in.
  - Optional transport?: string
  - Optional variables?: Containers
- callback: (err: Error, channel: Channel) => void
  - - (err: Error, channel: Channel): void
    - Parameters
      - err: Error
      - channel: Channel
      Returns void
Returns void
- Defined in index.d.ts:4955
Start an External Media session. Create a channel to an External Media source/sink.

Parameters
- params: { app: string; connection_type?: string; direction?: string; encapsulation?: string; external_host: string; format: string; transport?: string; variables?: Containers }
  - app: string
    
    Stasis Application to place channel into.
  - Optional connection_type?: string
  - Optional direction?: string
  - Optional encapsulation?: string
  - external_host: string
    
    Hostname/ip:port of external host.
  - format: string
    
    Format to encode audio in.
  - Optional transport?: string
  - Optional variables?: Containers
Returns Promise<Channel>

get

get(callback: (err: Error, channel: Channel) => void): void
get(): Promise<Channel>

- Defined in index.d.ts:4322
Channel details.

Parameters
- callback: (err: Error, channel: Channel) => void
  - - (err: Error, channel: Channel): void
    - Parameters
      - err: Error
      - channel: Channel
      Returns void
Returns void
- Defined in index.d.ts:4327
Channel details.

Returns Promise<Channel>

getChannelVar

getChannelVar(params: { variable: string }, callback: (err: Error, variable: Variable) => void): void
getChannelVar(params: { variable: string }): Promise<Variable>

- Defined in index.d.ts:4793
Get the value of a channel variable or function.

Parameters
- params: { variable: string }
  - variable: string
    
    The channel variable or function to get.
- callback: (err: Error, variable: Variable) => void
  - - (err: Error, variable: Variable): void
    - Parameters
      - err: Error
      - variable: Variable
      Returns void
Returns void
- Defined in index.d.ts:4800
Get the value of a channel variable or function.

Parameters
- params: { variable: string }
  - variable: string
    
    The channel variable or function to get.
Returns Promise<Variable>

hangup

hangup(params: { reason?: string }, callback: (err: Error) => void): void
hangup(callback: (err: Error) => void): void
hangup(params?: { reason?: string }): Promise<void>

- Defined in index.d.ts:4411
Delete (i.e. hangup) a channel.

Parameters
- params: { reason?: string }
  - Optional reason?: string
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4416
Delete (i.e. hangup) a channel.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4423
Delete (i.e. hangup) a channel.

Parameters
- Optional params: { reason?: string }
  - Optional reason?: string
Returns Promise<void>

hold

hold(callback: (err: Error) => void): void
hold(): Promise<void>

- Defined in index.d.ts:4595
Hold a channel.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4600
Hold a channel.

Returns Promise<void>

list

list(callback: (err: Error, channels: Channel[]) => void): void
list(): Promise<Channel[]>

- Defined in index.d.ts:4194
List all active channels in Asterisk.

Parameters
- callback: (err: Error, channels: Channel[]) => void
  - - (err: Error, channels: Channel[]): void
    - Parameters
      - err: Error
      - channels: Channel[]
      Returns void
Returns void
- Defined in index.d.ts:4199
List all active channels in Asterisk.

Returns Promise<Channel[]>

move

move(params: { app: string; appArgs?: string }, callback: (err: Error) => void): void
move(params: { app: string; appArgs?: string }): Promise<void>

- Defined in index.d.ts:4464
Move the channel from one Stasis application to another.

Parameters
- params: { app: string; appArgs?: string }
  - app: string
    
    The channel will be passed to this Stasis application.
  - Optional appArgs?: string
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4472
Move the channel from one Stasis application to another.

Parameters
- params: { app: string; appArgs?: string }
  - app: string
    
    The channel will be passed to this Stasis application.
  - Optional appArgs?: string
Returns Promise<void>

mute

mute(params: { direction?: string }, callback: (err: Error) => void): void
mute(callback: (err: Error) => void): void
mute(params?: { direction?: string }): Promise<void>

- Defined in index.d.ts:4559
Mute a channel.

Parameters
- params: { direction?: string }
  - Optional direction?: string
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4564
Mute a channel.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4571
Mute a channel.

Parameters
- Optional params: { direction?: string }
  - Optional direction?: string
Returns Promise<void>

on

on(event: "Message", callback: (event: Message, instances: Message) => void): void
on(event: "MissingParams", callback: (event: MissingParams, instances: MissingParams) => void): void
on(event: "Event", callback: (event: Event, instances: Event) => void): void
on(event: "ContactInfo", callback: (event: ContactInfo, instances: ContactInfo) => void): void
on(event: "Peer", callback: (event: Peer, instances: Peer) => void): void
on(event: "DeviceStateChanged", callback: (event: DeviceStateChanged, devicestate: DeviceState) => void): void
on(event: "PlaybackStarted", callback: (event: PlaybackStarted, playback: Playback) => void): void
on(event: "PlaybackContinuing", callback: (event: PlaybackContinuing, playback: Playback) => void): void
on(event: "PlaybackFinished", callback: (event: PlaybackFinished, playback: Playback) => void): void
on(event: "RecordingStarted", callback: (event: RecordingStarted, liverecording: LiveRecording) => void): void
on(event: "RecordingFinished", callback: (event: RecordingFinished, liverecording: LiveRecording) => void): void
on(event: "RecordingFailed", callback: (event: RecordingFailed, liverecording: LiveRecording) => void): void
on(event: "ApplicationMoveFailed", callback: (event: ApplicationMoveFailed, channel: Channel) => void): void
on(event: "ApplicationReplaced", callback: (event: Event) => void): void
on(event: "BridgeCreated", callback: (event: BridgeCreated, bridge: Bridge) => void): void
on(event: "BridgeDestroyed", callback: (event: BridgeDestroyed, bridge: Bridge) => void): void
on(event: "BridgeMerged", callback: (event: BridgeMerged, bridge: Bridge) => void): void
on(event: "BridgeVideoSourceChanged", callback: (event: BridgeVideoSourceChanged, bridge: Bridge) => void): void
on(event: "BridgeBlindTransfer", callback: (event: BridgeBlindTransfer, instances: BridgeBlindTransfer) => void): void
on(event: "BridgeAttendedTransfer", callback: (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer) => void): void
on(event: "ChannelCreated", callback: (event: ChannelCreated, channel: Channel) => void): void
on(event: "ChannelDestroyed", callback: (event: ChannelDestroyed, channel: Channel) => void): void
on(event: "ChannelEnteredBridge", callback: (event: ChannelEnteredBridge, instances: ChannelEnteredBridge) => void): void
on(event: "ChannelLeftBridge", callback: (event: ChannelLeftBridge, instances: ChannelLeftBridge) => void): void
on(event: "ChannelStateChange", callback: (event: ChannelStateChange, channel: Channel) => void): void
on(event: "ChannelDtmfReceived", callback: (event: ChannelDtmfReceived, channel: Channel) => void): void
on(event: "ChannelDialplan", callback: (event: ChannelDialplan, channel: Channel) => void): void
on(event: "ChannelCallerId", callback: (event: ChannelCallerId, channel: Channel) => void): void
on(event: "ChannelUserevent", callback: (event: ChannelUserevent, instances: ChannelUserevent) => void): void
on(event: "ChannelHangupRequest", callback: (event: ChannelHangupRequest, channel: Channel) => void): void
on(event: "ChannelVarset", callback: (event: ChannelVarset, channel: Channel) => void): void
on(event: "ChannelHold", callback: (event: ChannelHold, channel: Channel) => void): void
on(event: "ChannelUnhold", callback: (event: ChannelUnhold, channel: Channel) => void): void
on(event: "ChannelTalkingStarted", callback: (event: ChannelTalkingStarted, channel: Channel) => void): void
on(event: "ChannelTalkingFinished", callback: (event: ChannelTalkingFinished, channel: Channel) => void): void
on(event: "ContactStatusChange", callback: (event: ContactStatusChange, endpoint: Endpoint) => void): void
on(event: "PeerStatusChange", callback: (event: PeerStatusChange, endpoint: Endpoint) => void): void
on(event: "EndpointStateChange", callback: (event: EndpointStateChange, endpoint: Endpoint) => void): void
on(event: "Dial", callback: (event: Dial, channel: Channel) => void): void
on(event: "StasisEnd", callback: (event: StasisEnd, channel: Channel) => void): void
on(event: "StasisStart", callback: (event: StasisStart, channel: Channel) => void): void
on(event: "TextMessageReceived", callback: (event: TextMessageReceived, endpoint: Endpoint) => void): void
on(event: "ChannelConnectedLine", callback: (event: ChannelConnectedLine, channel: Channel) => void): void

Inherited from Resource.on
- Defined in index.d.ts:898
Base type for errors and events.

Parameters
- event: "Message"
- callback: (event: Message, instances: Message) => void
  - - (event: Message, instances: Message): void
    - Parameters
      - event: Message
      - instances: Message
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:903
Error event sent when required params are missing.

Parameters
- event: "MissingParams"
- callback: (event: MissingParams, instances: MissingParams) => void
  - - (event: MissingParams, instances: MissingParams): void
    - Parameters
      - event: MissingParams
      - instances: MissingParams
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:908
Base type for asynchronous events from Asterisk.

Parameters
- event: "Event"
- callback: (event: Event, instances: Event) => void
  - - (event: Event, instances: Event): void
    - Parameters
      - event: Event
      - instances: Event
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:913
Detailed information about a contact on an endpoint.

Parameters
- event: "ContactInfo"
- callback: (event: ContactInfo, instances: ContactInfo) => void
  - - (event: ContactInfo, instances: ContactInfo): void
    - Parameters
      - event: ContactInfo
      - instances: ContactInfo
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:918
Detailed information about a remote peer that communicates with Asterisk.

Parameters
- event: "Peer"
- callback: (event: Peer, instances: Peer) => void
  - - (event: Peer, instances: Peer): void
    - Parameters
      - event: Peer
      - instances: Peer
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:923
Notification that a device state has changed.

Parameters
- event: "DeviceStateChanged"
- callback: (event: DeviceStateChanged, devicestate: DeviceState) => void
  - - (event: DeviceStateChanged, devicestate: DeviceState): void
    - Parameters
      - event: DeviceStateChanged
      - devicestate: DeviceState
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:931
Event showing the start of a media playback operation.

Parameters
- event: "PlaybackStarted"
- callback: (event: PlaybackStarted, playback: Playback) => void
  - - (event: PlaybackStarted, playback: Playback): void
    - Parameters
      - event: PlaybackStarted
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:936
Event showing the continuation of a media playback operation from one media URI to the next in the list.

Parameters
- event: "PlaybackContinuing"
- callback: (event: PlaybackContinuing, playback: Playback) => void
  - - (event: PlaybackContinuing, playback: Playback): void
    - Parameters
      - event: PlaybackContinuing
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:941
Event showing the completion of a media playback operation.

Parameters
- event: "PlaybackFinished"
- callback: (event: PlaybackFinished, playback: Playback) => void
  - - (event: PlaybackFinished, playback: Playback): void
    - Parameters
      - event: PlaybackFinished
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:946
Event showing the start of a recording operation.

Parameters
- event: "RecordingStarted"
- callback: (event: RecordingStarted, liverecording: LiveRecording) => void
  - - (event: RecordingStarted, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingStarted
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:954
Event showing the completion of a recording operation.

Parameters
- event: "RecordingFinished"
- callback: (event: RecordingFinished, liverecording: LiveRecording) => void
  - - (event: RecordingFinished, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingFinished
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:962
Event showing failure of a recording operation.

Parameters
- event: "RecordingFailed"
- callback: (event: RecordingFailed, liverecording: LiveRecording) => void
  - - (event: RecordingFailed, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingFailed
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:967
Notification that trying to move a channel to another Stasis application failed.

Parameters
- event: "ApplicationMoveFailed"
- callback: (event: ApplicationMoveFailed, channel: Channel) => void
  - - (event: ApplicationMoveFailed, channel: Channel): void
    - Parameters
      - event: ApplicationMoveFailed
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:973
Notification that another WebSocket has taken over for an application. An application may only be subscribed to by a single WebSocket at a time. If multiple WebSockets attempt to subscribe to the same application, the newer WebSocket wins, and the older one receives this event.

Parameters
- event: "ApplicationReplaced"
- callback: (event: Event) => void
  - - (event: Event): void
    - Parameters
      - event: Event
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:978
Notification that a bridge has been created.

Parameters
- event: "BridgeCreated"
- callback: (event: BridgeCreated, bridge: Bridge) => void
  - - (event: BridgeCreated, bridge: Bridge): void
    - Parameters
      - event: BridgeCreated
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:983
Notification that a bridge has been destroyed.

Parameters
- event: "BridgeDestroyed"
- callback: (event: BridgeDestroyed, bridge: Bridge) => void
  - - (event: BridgeDestroyed, bridge: Bridge): void
    - Parameters
      - event: BridgeDestroyed
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:988
Notification that one bridge has merged into another.

Parameters
- event: "BridgeMerged"
- callback: (event: BridgeMerged, bridge: Bridge) => void
  - - (event: BridgeMerged, bridge: Bridge): void
    - Parameters
      - event: BridgeMerged
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:993
Notification that the source of video in a bridge has changed.

Parameters
- event: "BridgeVideoSourceChanged"
- callback: (event: BridgeVideoSourceChanged, bridge: Bridge) => void
  - - (event: BridgeVideoSourceChanged, bridge: Bridge): void
    - Parameters
      - event: BridgeVideoSourceChanged
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1001
Notification that a blind transfer has occurred.

Parameters
- event: "BridgeBlindTransfer"
- callback: (event: BridgeBlindTransfer, instances: BridgeBlindTransfer) => void
  - - (event: BridgeBlindTransfer, instances: BridgeBlindTransfer): void
    - Parameters
      - event: BridgeBlindTransfer
      - instances: BridgeBlindTransfer
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1009
Notification that an attended transfer has occurred.

Parameters
- event: "BridgeAttendedTransfer"
- callback: (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer) => void
  - - (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer): void
    - Parameters
      - event: BridgeAttendedTransfer
      - instances: BridgeAttendedTransfer
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1017
Notification that a channel has been created.

Parameters
- event: "ChannelCreated"
- callback: (event: ChannelCreated, channel: Channel) => void
  - - (event: ChannelCreated, channel: Channel): void
    - Parameters
      - event: ChannelCreated
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1022
Notification that a channel has been destroyed.

Parameters
- event: "ChannelDestroyed"
- callback: (event: ChannelDestroyed, channel: Channel) => void
  - - (event: ChannelDestroyed, channel: Channel): void
    - Parameters
      - event: ChannelDestroyed
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1027
Notification that a channel has entered a bridge.

Parameters
- event: "ChannelEnteredBridge"
- callback: (event: ChannelEnteredBridge, instances: ChannelEnteredBridge) => void
  - - (event: ChannelEnteredBridge, instances: ChannelEnteredBridge): void
    - Parameters
      - event: ChannelEnteredBridge
      - instances: ChannelEnteredBridge
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1035
Notification that a channel has left a bridge.

Parameters
- event: "ChannelLeftBridge"
- callback: (event: ChannelLeftBridge, instances: ChannelLeftBridge) => void
  - - (event: ChannelLeftBridge, instances: ChannelLeftBridge): void
    - Parameters
      - event: ChannelLeftBridge
      - instances: ChannelLeftBridge
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1043
Notification of a channels state change.

Parameters
- event: "ChannelStateChange"
- callback: (event: ChannelStateChange, channel: Channel) => void
  - - (event: ChannelStateChange, channel: Channel): void
    - Parameters
      - event: ChannelStateChange
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1048
DTMF received on a channel. This event is sent when the DTMF ends. There is no notification about the start of DTMF.

Parameters
- event: "ChannelDtmfReceived"
- callback: (event: ChannelDtmfReceived, channel: Channel) => void
  - - (event: ChannelDtmfReceived, channel: Channel): void
    - Parameters
      - event: ChannelDtmfReceived
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1053
Channel changed location in the dialplan.

Parameters
- event: "ChannelDialplan"
- callback: (event: ChannelDialplan, channel: Channel) => void
  - - (event: ChannelDialplan, channel: Channel): void
    - Parameters
      - event: ChannelDialplan
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1058
Channel changed Caller ID.

Parameters
- event: "ChannelCallerId"
- callback: (event: ChannelCallerId, channel: Channel) => void
  - - (event: ChannelCallerId, channel: Channel): void
    - Parameters
      - event: ChannelCallerId
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1063
User-generated event with additional user-defined fields in the object.

Parameters
- event: "ChannelUserevent"
- callback: (event: ChannelUserevent, instances: ChannelUserevent) => void
  - - (event: ChannelUserevent, instances: ChannelUserevent): void
    - Parameters
      - event: ChannelUserevent
      - instances: ChannelUserevent
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1071
A hangup was requested on the channel.

Parameters
- event: "ChannelHangupRequest"
- callback: (event: ChannelHangupRequest, channel: Channel) => void
  - - (event: ChannelHangupRequest, channel: Channel): void
    - Parameters
      - event: ChannelHangupRequest
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1076
Channel variable changed.

Parameters
- event: "ChannelVarset"
- callback: (event: ChannelVarset, channel: Channel) => void
  - - (event: ChannelVarset, channel: Channel): void
    - Parameters
      - event: ChannelVarset
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1081
A channel initiated a media hold.

Parameters
- event: "ChannelHold"
- callback: (event: ChannelHold, channel: Channel) => void
  - - (event: ChannelHold, channel: Channel): void
    - Parameters
      - event: ChannelHold
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1086
A channel initiated a media unhold.

Parameters
- event: "ChannelUnhold"
- callback: (event: ChannelUnhold, channel: Channel) => void
  - - (event: ChannelUnhold, channel: Channel): void
    - Parameters
      - event: ChannelUnhold
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1091
Talking was detected on the channel.

Parameters
- event: "ChannelTalkingStarted"
- callback: (event: ChannelTalkingStarted, channel: Channel) => void
  - - (event: ChannelTalkingStarted, channel: Channel): void
    - Parameters
      - event: ChannelTalkingStarted
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1096
Talking is no longer detected on the channel.

Parameters
- event: "ChannelTalkingFinished"
- callback: (event: ChannelTalkingFinished, channel: Channel) => void
  - - (event: ChannelTalkingFinished, channel: Channel): void
    - Parameters
      - event: ChannelTalkingFinished
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1104
The state of a contact on an endpoint has changed.

Parameters
- event: "ContactStatusChange"
- callback: (event: ContactStatusChange, endpoint: Endpoint) => void
  - - (event: ContactStatusChange, endpoint: Endpoint): void
    - Parameters
      - event: ContactStatusChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1109
The state of a peer associated with an endpoint has changed.

Parameters
- event: "PeerStatusChange"
- callback: (event: PeerStatusChange, endpoint: Endpoint) => void
  - - (event: PeerStatusChange, endpoint: Endpoint): void
    - Parameters
      - event: PeerStatusChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1114
Endpoint state changed.

Parameters
- event: "EndpointStateChange"
- callback: (event: EndpointStateChange, endpoint: Endpoint) => void
  - - (event: EndpointStateChange, endpoint: Endpoint): void
    - Parameters
      - event: EndpointStateChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1119
Dialing state has changed.

Parameters
- event: "Dial"
- callback: (event: Dial, channel: Channel) => void
  - - (event: Dial, channel: Channel): void
    - Parameters
      - event: Dial
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1124
Notification that a channel has left a Stasis application.

Parameters
- event: "StasisEnd"
- callback: (event: StasisEnd, channel: Channel) => void
  - - (event: StasisEnd, channel: Channel): void
    - Parameters
      - event: StasisEnd
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1129
Notification that a channel has entered a Stasis application.

Parameters
- event: "StasisStart"
- callback: (event: StasisStart, channel: Channel) => void
  - - (event: StasisStart, channel: Channel): void
    - Parameters
      - event: StasisStart
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1134
A text message was received from an endpoint.

Parameters
- event: "TextMessageReceived"
- callback: (event: TextMessageReceived, endpoint: Endpoint) => void
  - - (event: TextMessageReceived, endpoint: Endpoint): void
    - Parameters
      - event: TextMessageReceived
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1139
Channel changed Connected Line.

Parameters
- event: "ChannelConnectedLine"
- callback: (event: ChannelConnectedLine, channel: Channel) => void
  - - (event: ChannelConnectedLine, channel: Channel): void
    - Parameters
      - event: ChannelConnectedLine
      - channel: Channel
      Returns void
Returns void

once

once(event: "Message", callback: (event: Message, instances: Message) => void): void
once(event: "MissingParams", callback: (event: MissingParams, instances: MissingParams) => void): void
once(event: "Event", callback: (event: Event, instances: Event) => void): void
once(event: "ContactInfo", callback: (event: ContactInfo, instances: ContactInfo) => void): void
once(event: "Peer", callback: (event: Peer, instances: Peer) => void): void
once(event: "DeviceStateChanged", callback: (event: DeviceStateChanged, devicestate: DeviceState) => void): void
once(event: "PlaybackStarted", callback: (event: PlaybackStarted, playback: Playback) => void): void
once(event: "PlaybackContinuing", callback: (event: PlaybackContinuing, playback: Playback) => void): void
once(event: "PlaybackFinished", callback: (event: PlaybackFinished, playback: Playback) => void): void
once(event: "RecordingStarted", callback: (event: RecordingStarted, liverecording: LiveRecording) => void): void
once(event: "RecordingFinished", callback: (event: RecordingFinished, liverecording: LiveRecording) => void): void
once(event: "RecordingFailed", callback: (event: RecordingFailed, liverecording: LiveRecording) => void): void
once(event: "ApplicationMoveFailed", callback: (event: ApplicationMoveFailed, channel: Channel) => void): void
once(event: "ApplicationReplaced", callback: (event: Event) => void): void
once(event: "BridgeCreated", callback: (event: BridgeCreated, bridge: Bridge) => void): void
once(event: "BridgeDestroyed", callback: (event: BridgeDestroyed, bridge: Bridge) => void): void
once(event: "BridgeMerged", callback: (event: BridgeMerged, bridge: Bridge) => void): void
once(event: "BridgeVideoSourceChanged", callback: (event: BridgeVideoSourceChanged, bridge: Bridge) => void): void
once(event: "BridgeBlindTransfer", callback: (event: BridgeBlindTransfer, instances: BridgeBlindTransfer) => void): void
once(event: "BridgeAttendedTransfer", callback: (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer) => void): void
once(event: "ChannelCreated", callback: (event: ChannelCreated, channel: Channel) => void): void
once(event: "ChannelDestroyed", callback: (event: ChannelDestroyed, channel: Channel) => void): void
once(event: "ChannelEnteredBridge", callback: (event: ChannelEnteredBridge, instances: ChannelEnteredBridge) => void): void
once(event: "ChannelLeftBridge", callback: (event: ChannelLeftBridge, instances: ChannelLeftBridge) => void): void
once(event: "ChannelStateChange", callback: (event: ChannelStateChange, channel: Channel) => void): void
once(event: "ChannelDtmfReceived", callback: (event: ChannelDtmfReceived, channel: Channel) => void): void
once(event: "ChannelDialplan", callback: (event: ChannelDialplan, channel: Channel) => void): void
once(event: "ChannelCallerId", callback: (event: ChannelCallerId, channel: Channel) => void): void
once(event: "ChannelUserevent", callback: (event: ChannelUserevent, instances: ChannelUserevent) => void): void
once(event: "ChannelHangupRequest", callback: (event: ChannelHangupRequest, channel: Channel) => void): void
once(event: "ChannelVarset", callback: (event: ChannelVarset, channel: Channel) => void): void
once(event: "ChannelHold", callback: (event: ChannelHold, channel: Channel) => void): void
once(event: "ChannelUnhold", callback: (event: ChannelUnhold, channel: Channel) => void): void
once(event: "ChannelTalkingStarted", callback: (event: ChannelTalkingStarted, channel: Channel) => void): void
once(event: "ChannelTalkingFinished", callback: (event: ChannelTalkingFinished, channel: Channel) => void): void
once(event: "ContactStatusChange", callback: (event: ContactStatusChange, endpoint: Endpoint) => void): void
once(event: "PeerStatusChange", callback: (event: PeerStatusChange, endpoint: Endpoint) => void): void
once(event: "EndpointStateChange", callback: (event: EndpointStateChange, endpoint: Endpoint) => void): void
once(event: "Dial", callback: (event: Dial, channel: Channel) => void): void
once(event: "StasisEnd", callback: (event: StasisEnd, channel: Channel) => void): void
once(event: "StasisStart", callback: (event: StasisStart, channel: Channel) => void): void
once(event: "TextMessageReceived", callback: (event: TextMessageReceived, endpoint: Endpoint) => void): void
once(event: "ChannelConnectedLine", callback: (event: ChannelConnectedLine, channel: Channel) => void): void

Inherited from Resource.once
- Defined in index.d.ts:1144
Base type for errors and events.

Parameters
- event: "Message"
- callback: (event: Message, instances: Message) => void
  - - (event: Message, instances: Message): void
    - Parameters
      - event: Message
      - instances: Message
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1149
Error event sent when required params are missing.

Parameters
- event: "MissingParams"
- callback: (event: MissingParams, instances: MissingParams) => void
  - - (event: MissingParams, instances: MissingParams): void
    - Parameters
      - event: MissingParams
      - instances: MissingParams
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1154
Base type for asynchronous events from Asterisk.

Parameters
- event: "Event"
- callback: (event: Event, instances: Event) => void
  - - (event: Event, instances: Event): void
    - Parameters
      - event: Event
      - instances: Event
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1159
Detailed information about a contact on an endpoint.

Parameters
- event: "ContactInfo"
- callback: (event: ContactInfo, instances: ContactInfo) => void
  - - (event: ContactInfo, instances: ContactInfo): void
    - Parameters
      - event: ContactInfo
      - instances: ContactInfo
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1164
Detailed information about a remote peer that communicates with Asterisk.

Parameters
- event: "Peer"
- callback: (event: Peer, instances: Peer) => void
  - - (event: Peer, instances: Peer): void
    - Parameters
      - event: Peer
      - instances: Peer
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1169
Notification that a device state has changed.

Parameters
- event: "DeviceStateChanged"
- callback: (event: DeviceStateChanged, devicestate: DeviceState) => void
  - - (event: DeviceStateChanged, devicestate: DeviceState): void
    - Parameters
      - event: DeviceStateChanged
      - devicestate: DeviceState
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1177
Event showing the start of a media playback operation.

Parameters
- event: "PlaybackStarted"
- callback: (event: PlaybackStarted, playback: Playback) => void
  - - (event: PlaybackStarted, playback: Playback): void
    - Parameters
      - event: PlaybackStarted
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1182
Event showing the continuation of a media playback operation from one media URI to the next in the list.

Parameters
- event: "PlaybackContinuing"
- callback: (event: PlaybackContinuing, playback: Playback) => void
  - - (event: PlaybackContinuing, playback: Playback): void
    - Parameters
      - event: PlaybackContinuing
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1187
Event showing the completion of a media playback operation.

Parameters
- event: "PlaybackFinished"
- callback: (event: PlaybackFinished, playback: Playback) => void
  - - (event: PlaybackFinished, playback: Playback): void
    - Parameters
      - event: PlaybackFinished
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1192
Event showing the start of a recording operation.

Parameters
- event: "RecordingStarted"
- callback: (event: RecordingStarted, liverecording: LiveRecording) => void
  - - (event: RecordingStarted, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingStarted
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1200
Event showing the completion of a recording operation.

Parameters
- event: "RecordingFinished"
- callback: (event: RecordingFinished, liverecording: LiveRecording) => void
  - - (event: RecordingFinished, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingFinished
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1208
Event showing failure of a recording operation.

Parameters
- event: "RecordingFailed"
- callback: (event: RecordingFailed, liverecording: LiveRecording) => void
  - - (event: RecordingFailed, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingFailed
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1216
Notification that trying to move a channel to another Stasis application failed.

Parameters
- event: "ApplicationMoveFailed"
- callback: (event: ApplicationMoveFailed, channel: Channel) => void
  - - (event: ApplicationMoveFailed, channel: Channel): void
    - Parameters
      - event: ApplicationMoveFailed
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1225
Notification that another WebSocket has taken over for an application. An application may only be subscribed to by a single WebSocket at a time. If multiple WebSockets attempt to subscribe to the same application, the newer WebSocket wins, and the older one receives this event.

Parameters
- event: "ApplicationReplaced"
- callback: (event: Event) => void
  - - (event: Event): void
    - Parameters
      - event: Event
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1230
Notification that a bridge has been created.

Parameters
- event: "BridgeCreated"
- callback: (event: BridgeCreated, bridge: Bridge) => void
  - - (event: BridgeCreated, bridge: Bridge): void
    - Parameters
      - event: BridgeCreated
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1235
Notification that a bridge has been destroyed.

Parameters
- event: "BridgeDestroyed"
- callback: (event: BridgeDestroyed, bridge: Bridge) => void
  - - (event: BridgeDestroyed, bridge: Bridge): void
    - Parameters
      - event: BridgeDestroyed
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1240
Notification that one bridge has merged into another.

Parameters
- event: "BridgeMerged"
- callback: (event: BridgeMerged, bridge: Bridge) => void
  - - (event: BridgeMerged, bridge: Bridge): void
    - Parameters
      - event: BridgeMerged
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1245
Notification that the source of video in a bridge has changed.

Parameters
- event: "BridgeVideoSourceChanged"
- callback: (event: BridgeVideoSourceChanged, bridge: Bridge) => void
  - - (event: BridgeVideoSourceChanged, bridge: Bridge): void
    - Parameters
      - event: BridgeVideoSourceChanged
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1253
Notification that a blind transfer has occurred.

Parameters
- event: "BridgeBlindTransfer"
- callback: (event: BridgeBlindTransfer, instances: BridgeBlindTransfer) => void
  - - (event: BridgeBlindTransfer, instances: BridgeBlindTransfer): void
    - Parameters
      - event: BridgeBlindTransfer
      - instances: BridgeBlindTransfer
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1261
Notification that an attended transfer has occurred.

Parameters
- event: "BridgeAttendedTransfer"
- callback: (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer) => void
  - - (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer): void
    - Parameters
      - event: BridgeAttendedTransfer
      - instances: BridgeAttendedTransfer
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1269
Notification that a channel has been created.

Parameters
- event: "ChannelCreated"
- callback: (event: ChannelCreated, channel: Channel) => void
  - - (event: ChannelCreated, channel: Channel): void
    - Parameters
      - event: ChannelCreated
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1274
Notification that a channel has been destroyed.

Parameters
- event: "ChannelDestroyed"
- callback: (event: ChannelDestroyed, channel: Channel) => void
  - - (event: ChannelDestroyed, channel: Channel): void
    - Parameters
      - event: ChannelDestroyed
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1279
Notification that a channel has entered a bridge.

Parameters
- event: "ChannelEnteredBridge"
- callback: (event: ChannelEnteredBridge, instances: ChannelEnteredBridge) => void
  - - (event: ChannelEnteredBridge, instances: ChannelEnteredBridge): void
    - Parameters
      - event: ChannelEnteredBridge
      - instances: ChannelEnteredBridge
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1287
Notification that a channel has left a bridge.

Parameters
- event: "ChannelLeftBridge"
- callback: (event: ChannelLeftBridge, instances: ChannelLeftBridge) => void
  - - (event: ChannelLeftBridge, instances: ChannelLeftBridge): void
    - Parameters
      - event: ChannelLeftBridge
      - instances: ChannelLeftBridge
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1295
Notification of a channels state change.

Parameters
- event: "ChannelStateChange"
- callback: (event: ChannelStateChange, channel: Channel) => void
  - - (event: ChannelStateChange, channel: Channel): void
    - Parameters
      - event: ChannelStateChange
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1300
DTMF received on a channel. This event is sent when the DTMF ends. There is no notification about the start of DTMF.

Parameters
- event: "ChannelDtmfReceived"
- callback: (event: ChannelDtmfReceived, channel: Channel) => void
  - - (event: ChannelDtmfReceived, channel: Channel): void
    - Parameters
      - event: ChannelDtmfReceived
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1305
Channel changed location in the dialplan.

Parameters
- event: "ChannelDialplan"
- callback: (event: ChannelDialplan, channel: Channel) => void
  - - (event: ChannelDialplan, channel: Channel): void
    - Parameters
      - event: ChannelDialplan
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1310
Channel changed Caller ID.

Parameters
- event: "ChannelCallerId"
- callback: (event: ChannelCallerId, channel: Channel) => void
  - - (event: ChannelCallerId, channel: Channel): void
    - Parameters
      - event: ChannelCallerId
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1315
User-generated event with additional user-defined fields in the object.

Parameters
- event: "ChannelUserevent"
- callback: (event: ChannelUserevent, instances: ChannelUserevent) => void
  - - (event: ChannelUserevent, instances: ChannelUserevent): void
    - Parameters
      - event: ChannelUserevent
      - instances: ChannelUserevent
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1323
A hangup was requested on the channel.

Parameters
- event: "ChannelHangupRequest"
- callback: (event: ChannelHangupRequest, channel: Channel) => void
  - - (event: ChannelHangupRequest, channel: Channel): void
    - Parameters
      - event: ChannelHangupRequest
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1328
Channel variable changed.

Parameters
- event: "ChannelVarset"
- callback: (event: ChannelVarset, channel: Channel) => void
  - - (event: ChannelVarset, channel: Channel): void
    - Parameters
      - event: ChannelVarset
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1333
A channel initiated a media hold.

Parameters
- event: "ChannelHold"
- callback: (event: ChannelHold, channel: Channel) => void
  - - (event: ChannelHold, channel: Channel): void
    - Parameters
      - event: ChannelHold
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1338
A channel initiated a media unhold.

Parameters
- event: "ChannelUnhold"
- callback: (event: ChannelUnhold, channel: Channel) => void
  - - (event: ChannelUnhold, channel: Channel): void
    - Parameters
      - event: ChannelUnhold
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1343
Talking was detected on the channel.

Parameters
- event: "ChannelTalkingStarted"
- callback: (event: ChannelTalkingStarted, channel: Channel) => void
  - - (event: ChannelTalkingStarted, channel: Channel): void
    - Parameters
      - event: ChannelTalkingStarted
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1351
Talking is no longer detected on the channel.

Parameters
- event: "ChannelTalkingFinished"
- callback: (event: ChannelTalkingFinished, channel: Channel) => void
  - - (event: ChannelTalkingFinished, channel: Channel): void
    - Parameters
      - event: ChannelTalkingFinished
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1359
The state of a contact on an endpoint has changed.

Parameters
- event: "ContactStatusChange"
- callback: (event: ContactStatusChange, endpoint: Endpoint) => void
  - - (event: ContactStatusChange, endpoint: Endpoint): void
    - Parameters
      - event: ContactStatusChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1364
The state of a peer associated with an endpoint has changed.

Parameters
- event: "PeerStatusChange"
- callback: (event: PeerStatusChange, endpoint: Endpoint) => void
  - - (event: PeerStatusChange, endpoint: Endpoint): void
    - Parameters
      - event: PeerStatusChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1369
Endpoint state changed.

Parameters
- event: "EndpointStateChange"
- callback: (event: EndpointStateChange, endpoint: Endpoint) => void
  - - (event: EndpointStateChange, endpoint: Endpoint): void
    - Parameters
      - event: EndpointStateChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1374
Dialing state has changed.

Parameters
- event: "Dial"
- callback: (event: Dial, channel: Channel) => void
  - - (event: Dial, channel: Channel): void
    - Parameters
      - event: Dial
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1379
Notification that a channel has left a Stasis application.

Parameters
- event: "StasisEnd"
- callback: (event: StasisEnd, channel: Channel) => void
  - - (event: StasisEnd, channel: Channel): void
    - Parameters
      - event: StasisEnd
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1384
Notification that a channel has entered a Stasis application.

Parameters
- event: "StasisStart"
- callback: (event: StasisStart, channel: Channel) => void
  - - (event: StasisStart, channel: Channel): void
    - Parameters
      - event: StasisStart
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1389
A text message was received from an endpoint.

Parameters
- event: "TextMessageReceived"
- callback: (event: TextMessageReceived, endpoint: Endpoint) => void
  - - (event: TextMessageReceived, endpoint: Endpoint): void
    - Parameters
      - event: TextMessageReceived
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1394
Channel changed Connected Line.

Parameters
- event: "ChannelConnectedLine"
- callback: (event: ChannelConnectedLine, channel: Channel) => void
  - - (event: ChannelConnectedLine, channel: Channel): void
    - Parameters
      - event: ChannelConnectedLine
      - channel: Channel
      Returns void
Returns void

originate

originate(params: { app?: string; appArgs?: string; callerId?: string; context?: string; endpoint: string; extension?: string; formats?: string; label?: string; originator?: string; otherChannelId?: string; priority?: number; timeout?: number; variables?: Containers }, callback: (err: Error, channel: Channel) => void): void
originate(params: { app?: string; appArgs?: string; callerId?: string; context?: string; endpoint: string; extension?: string; formats?: string; label?: string; originator?: string; otherChannelId?: string; priority?: number; timeout?: number; variables?: Containers }): Promise<Channel>

- Defined in index.d.ts:4222
Create a new channel (originate). The new channel is created immediately and a snapshot of it returned. If a Stasis application is provided it will be automatically subscribed to the originated channel for further events and updates.

Parameters
- params: { app?: string; appArgs?: string; callerId?: string; context?: string; endpoint: string; extension?: string; formats?: string; label?: string; originator?: string; otherChannelId?: string; priority?: number; timeout?: number; variables?: Containers }
  - Optional app?: string
  - Optional appArgs?: string
  - Optional callerId?: string
  - Optional context?: string
  - endpoint: string
    
    Endpoint to call.
  - Optional extension?: string
  - Optional formats?: string
  - Optional label?: string
  - Optional originator?: string
  - Optional otherChannelId?: string
  - Optional priority?: number
  - Optional timeout?: number
  - Optional variables?: Containers
- callback: (err: Error, channel: Channel) => void
  - - (err: Error, channel: Channel): void
    - Parameters
      - err: Error
      - channel: Channel
      Returns void
Returns void
- Defined in index.d.ts:4262
Create a new channel (originate). The new channel is created immediately and a snapshot of it returned. If a Stasis application is provided it will be automatically subscribed to the originated channel for further events and updates.

Parameters
- params: { app?: string; appArgs?: string; callerId?: string; context?: string; endpoint: string; extension?: string; formats?: string; label?: string; originator?: string; otherChannelId?: string; priority?: number; timeout?: number; variables?: Containers }
  - Optional app?: string
  - Optional appArgs?: string
  - Optional callerId?: string
  - Optional context?: string
  - endpoint: string
    
    Endpoint to call.
  - Optional extension?: string
  - Optional formats?: string
  - Optional label?: string
  - Optional originator?: string
  - Optional otherChannelId?: string
  - Optional priority?: number
  - Optional timeout?: number
  - Optional variables?: Containers
Returns Promise<Channel>

originateWithId

originateWithId(params: { app?: string; appArgs?: string; callerId?: string; context?: string; endpoint: string; extension?: string; formats?: string; label?: string; originator?: string; otherChannelId?: string; priority?: number; timeout?: number; variables?: Containers }, callback: (err: Error, channel: Channel) => void): void
originateWithId(params: { app?: string; appArgs?: string; callerId?: string; context?: string; endpoint: string; extension?: string; formats?: string; label?: string; originator?: string; otherChannelId?: string; priority?: number; timeout?: number; variables?: Containers }): Promise<Channel>

- Defined in index.d.ts:4350
Create a new channel (originate with id). The new channel is created immediately and a snapshot of it returned. If a Stasis application is provided it will be automatically subscribed to the originated channel for further events and updates.

Parameters
- params: { app?: string; appArgs?: string; callerId?: string; context?: string; endpoint: string; extension?: string; formats?: string; label?: string; originator?: string; otherChannelId?: string; priority?: number; timeout?: number; variables?: Containers }
  - Optional app?: string
  - Optional appArgs?: string
  - Optional callerId?: string
  - Optional context?: string
  - endpoint: string
    
    Endpoint to call.
  - Optional extension?: string
  - Optional formats?: string
  - Optional label?: string
  - Optional originator?: string
  - Optional otherChannelId?: string
  - Optional priority?: number
  - Optional timeout?: number
  - Optional variables?: Containers
- callback: (err: Error, channel: Channel) => void
  - - (err: Error, channel: Channel): void
    - Parameters
      - err: Error
      - channel: Channel
      Returns void
Returns void
- Defined in index.d.ts:4390
Create a new channel (originate with id). The new channel is created immediately and a snapshot of it returned. If a Stasis application is provided it will be automatically subscribed to the originated channel for further events and updates.

Parameters
- params: { app?: string; appArgs?: string; callerId?: string; context?: string; endpoint: string; extension?: string; formats?: string; label?: string; originator?: string; otherChannelId?: string; priority?: number; timeout?: number; variables?: Containers }
  - Optional app?: string
  - Optional appArgs?: string
  - Optional callerId?: string
  - Optional context?: string
  - endpoint: string
    
    Endpoint to call.
  - Optional extension?: string
  - Optional formats?: string
  - Optional label?: string
  - Optional originator?: string
  - Optional otherChannelId?: string
  - Optional priority?: number
  - Optional timeout?: number
  - Optional variables?: Containers
Returns Promise<Channel>

play

play(params: { lang?: string; media: string | string[]; offsetms?: number; playbackId?: string; skipms?: number }, playback: Playback, callback: (err: Error, playback: Playback) => void): void
play(params: { lang?: string; media: string | string[]; offsetms?: number; playbackId?: string; skipms?: number }, playback: Playback): Promise<Playback>

- Defined in index.d.ts:4680
Start playback of media. The media URI may be any of a number of URIs. Currently sound:, recording:, number:, digits:, characters:, and tone: URIs are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.).

Parameters
- params: { lang?: string; media: string | string[]; offsetms?: number; playbackId?: string; skipms?: number }
  - Optional lang?: string
  - media: string | string[]
    
    Media URIs to play.
  - Optional offsetms?: number
  - Optional playbackId?: string
  - Optional skipms?: number
- playback: Playback
- callback: (err: Error, playback: Playback) => void
  - - (err: Error, playback: Playback): void
    - Parameters
      - err: Error
      - playback: Playback
      Returns void
Returns void
- Defined in index.d.ts:4697
Start playback of media. The media URI may be any of a number of URIs. Currently sound:, recording:, number:, digits:, characters:, and tone: URIs are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.).

Parameters
- params: { lang?: string; media: string | string[]; offsetms?: number; playbackId?: string; skipms?: number }
  - Optional lang?: string
  - media: string | string[]
    
    Media URIs to play.
  - Optional offsetms?: number
  - Optional playbackId?: string
  - Optional skipms?: number
- playback: Playback
Returns Promise<Playback>

playWithId

playWithId(params: { lang?: string; media: string | string[]; offsetms?: number; playbackId: string; skipms?: number }, callback: (err: Error, playback: Playback) => void): void
playWithId(params: { lang?: string; media: string | string[]; offsetms?: number; playbackId: string; skipms?: number }): Promise<Playback>

- Defined in index.d.ts:4713
Start playback of media and specify the playbackId. The media URI may be any of a number of URIs. Currently sound:, recording:, number:, digits:, characters:, and tone: URIs are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.).

Parameters
- params: { lang?: string; media: string | string[]; offsetms?: number; playbackId: string; skipms?: number }
  - Optional lang?: string
  - media: string | string[]
    
    Media URIs to play.
  - Optional offsetms?: number
  - playbackId: string
    
    Playback ID.
  - Optional skipms?: number
- callback: (err: Error, playback: Playback) => void
  - - (err: Error, playback: Playback): void
    - Parameters
      - err: Error
      - playback: Playback
      Returns void
Returns void
- Defined in index.d.ts:4729
Start playback of media and specify the playbackId. The media URI may be any of a number of URIs. Currently sound:, recording:, number:, digits:, characters:, and tone: URIs are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.).

Parameters
- params: { lang?: string; media: string | string[]; offsetms?: number; playbackId: string; skipms?: number }
  - Optional lang?: string
  - media: string | string[]
    
    Media URIs to play.
  - Optional offsetms?: number
  - playbackId: string
    
    Playback ID.
  - Optional skipms?: number
Returns Promise<Playback>

record

record(params: { beep?: boolean; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }, recording: LiveRecording, callback: (err: Error, liverecording: LiveRecording) => void): void
record(params: { beep?: boolean; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }, recording: LiveRecording): Promise<LiveRecording>

- Defined in index.d.ts:4749
Start a recording. Record audio from a channel. Note that this will not capture audio sent to the channel. The bridge itself has a record feature if thats what you want.

Parameters
- params: { beep?: boolean; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }
  - Optional beep?: boolean
  - format: string
    
    Format to encode audio in.
  - Optional ifExists?: string
  - Optional maxDurationSeconds?: number
  - Optional maxSilenceSeconds?: number
  - name: string
    
    Recordings filename.
  - Optional terminateOn?: string
- recording: LiveRecording
- callback: (err: Error, liverecording: LiveRecording) => void
  - - (err: Error, liverecording: LiveRecording): void
    - Parameters
      - err: Error
      - liverecording: LiveRecording
      Returns void
Returns void
- Defined in index.d.ts:4775
Start a recording. Record audio from a channel. Note that this will not capture audio sent to the channel. The bridge itself has a record feature if thats what you want.

Parameters
- params: { beep?: boolean; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }
  - Optional beep?: boolean
  - format: string
    
    Format to encode audio in.
  - Optional ifExists?: string
  - Optional maxDurationSeconds?: number
  - Optional maxSilenceSeconds?: number
  - name: string
    
    Recordings filename.
  - Optional terminateOn?: string
- recording: LiveRecording
Returns Promise<LiveRecording>

redirect

redirect(params: { endpoint: string }, callback: (err: Error) => void): void
redirect(params: { endpoint: string }): Promise<void>

- Defined in index.d.ts:4479
Redirect the channel to a different location.

Parameters
- params: { endpoint: string }
  - endpoint: string
    
    The endpoint to redirect the channel to.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4486
Redirect the channel to a different location.

Parameters
- params: { endpoint: string }
  - endpoint: string
    
    The endpoint to redirect the channel to.
Returns Promise<void>

removeAllListeners

removeAllListeners(event?: AnyEventType): void

Inherited from Resource.removeAllListeners
- Defined in index.d.ts:1695
Removes all listeners, or those of the specified event type.

Parameters
- Optional event: AnyEventType
Returns void

removeListener

removeListener(event: AnyEventType, handler: (...args: any[]) => void): void

Inherited from Resource.removeListener
- Defined in index.d.ts:1689
Removes the event listener for the specified event type.

Parameters
- event: AnyEventType
  
  The event type.
- handler: (...args: any[]) => void
  
  The event listener function.
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns void

ring

ring(callback: (err: Error) => void): void
ring(): Promise<void>

- Defined in index.d.ts:4501
Indicate ringing to a channel.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4506
Indicate ringing to a channel.

Returns Promise<void>

ringStop

ringStop(callback: (err: Error) => void): void
ringStop(): Promise<void>

- Defined in index.d.ts:4511
Stop ringing indication on a channel if locally generated.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4516
Stop ringing indication on a channel if locally generated.

Returns Promise<void>

rtpstatistics

rtpstatistics(callback: (err: Error, rtpstat: RTPstat) => void): void
rtpstatistics(): Promise<RTPstat>

- Defined in index.d.ts:4906
RTP stats on a channel.

Parameters
- callback: (err: Error, rtpstat: RTPstat) => void
  - - (err: Error, rtpstat: RTPstat): void
    - Parameters
      - err: Error
      - rtpstat: RTPstat
      Returns void
Returns void
- Defined in index.d.ts:4911
RTP stats on a channel.

Returns Promise<RTPstat>

sendDTMF

sendDTMF(params: { after?: number; before?: number; between?: number; dtmf?: string; duration?: number }, callback: (err: Error) => void): void
sendDTMF(callback: (err: Error) => void): void
sendDTMF(params?: { after?: number; before?: number; between?: number; dtmf?: string; duration?: number }): Promise<void>

- Defined in index.d.ts:4527
Send provided DTMF to a given channel.

Parameters
- params: { after?: number; before?: number; between?: number; dtmf?: string; duration?: number }
  - Optional after?: number
  - Optional before?: number
  - Optional between?: number
  - Optional dtmf?: string
  - Optional duration?: number
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4535
Send provided DTMF to a given channel.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4546
Send provided DTMF to a given channel.

Parameters
- Optional params: { after?: number; before?: number; between?: number; dtmf?: string; duration?: number }
  - Optional after?: number
  - Optional before?: number
  - Optional between?: number
  - Optional dtmf?: string
  - Optional duration?: number
Returns Promise<void>

setChannelVar

setChannelVar(params: { value?: string; variable: string }, callback: (err: Error) => void): void
setChannelVar(params: { value?: string; variable: string }): Promise<void>

- Defined in index.d.ts:4808
Set the value of a channel variable or function.

Parameters
- params: { value?: string; variable: string }
  - Optional value?: string
  - variable: string
    
    The channel variable or function to set.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4816
Set the value of a channel variable or function.

Parameters
- params: { value?: string; variable: string }
  - Optional value?: string
  - variable: string
    
    The channel variable or function to set.
Returns Promise<void>

snoopChannel

snoopChannel(params: { app: string; appArgs?: string; snoopId?: string; spy?: string; whisper?: string }, snoopChannel: Channel, callback: (err: Error, channel: Channel) => void): void
snoopChannel(params: { app: string; appArgs?: string; snoopId?: string; spy?: string; whisper?: string }, snoopChannel: Channel): Promise<Channel>

- Defined in index.d.ts:4828
Start snooping. Snoop (spy/whisper) on a specific channel.

Parameters
- params: { app: string; appArgs?: string; snoopId?: string; spy?: string; whisper?: string }
  - app: string
    
    Application the snooping channel is placed into.
  - Optional appArgs?: string
  - Optional snoopId?: string
  - Optional spy?: string
  - Optional whisper?: string
- snoopChannel: Channel
- callback: (err: Error, channel: Channel) => void
  - - (err: Error, channel: Channel): void
    - Parameters
      - err: Error
      - channel: Channel
      Returns void
Returns void
- Defined in index.d.ts:4844
Start snooping. Snoop (spy/whisper) on a specific channel.

Parameters
- params: { app: string; appArgs?: string; snoopId?: string; spy?: string; whisper?: string }
  - app: string
    
    Application the snooping channel is placed into.
  - Optional appArgs?: string
  - Optional snoopId?: string
  - Optional spy?: string
  - Optional whisper?: string
- snoopChannel: Channel
Returns Promise<Channel>

snoopChannelWithId

snoopChannelWithId(params: { app: string; appArgs?: string; snoopId: string; spy?: string; whisper?: string }, callback: (err: Error, channel: Channel) => void): void
snoopChannelWithId(params: { app: string; appArgs?: string; snoopId: string; spy?: string; whisper?: string }): Promise<Channel>

- Defined in index.d.ts:4859
Start snooping. Snoop (spy/whisper) on a specific channel.

Parameters
- params: { app: string; appArgs?: string; snoopId: string; spy?: string; whisper?: string }
  - app: string
    
    Application the snooping channel is placed into.
  - Optional appArgs?: string
  - snoopId: string
    
    Unique ID to assign to snooping channel.
  - Optional spy?: string
  - Optional whisper?: string
- callback: (err: Error, channel: Channel) => void
  - - (err: Error, channel: Channel): void
    - Parameters
      - err: Error
      - channel: Channel
      Returns void
Returns void
- Defined in index.d.ts:4874
Start snooping. Snoop (spy/whisper) on a specific channel.

Parameters
- params: { app: string; appArgs?: string; snoopId: string; spy?: string; whisper?: string }
  - app: string
    
    Application the snooping channel is placed into.
  - Optional appArgs?: string
  - snoopId: string
    
    Unique ID to assign to snooping channel.
  - Optional spy?: string
  - Optional whisper?: string
Returns Promise<Channel>

startMoh

startMoh(params: { mohClass?: string }, callback: (err: Error) => void): void
startMoh(callback: (err: Error) => void): void
startMoh(params?: { mohClass?: string }): Promise<void>

- Defined in index.d.ts:4619
Play music on hold to a channel. Using media operations such as /play on a channel playing MOH in this manner will suspend MOH without resuming automatically. If continuing music on hold is desired, the stasis application must reinitiate music on hold.

Parameters
- params: { mohClass?: string }
  - Optional mohClass?: string
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4626
Play music on hold to a channel. Using media operations such as /play on a channel playing MOH in this manner will suspend MOH without resuming automatically. If continuing music on hold is desired, the stasis application must reinitiate music on hold.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4635
Play music on hold to a channel. Using media operations such as /play on a channel playing MOH in this manner will suspend MOH without resuming automatically. If continuing music on hold is desired, the stasis application must reinitiate music on hold.

Parameters
- Optional params: { mohClass?: string }
  - Optional mohClass?: string
Returns Promise<void>

startSilence

startSilence(callback: (err: Error) => void): void
startSilence(): Promise<void>

- Defined in index.d.ts:4651
Play silence to a channel. Using media operations such as /play on a channel playing silence in this manner will suspend silence without resuming automatically.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4657
Play silence to a channel. Using media operations such as /play on a channel playing silence in this manner will suspend silence without resuming automatically.

Returns Promise<void>

stopMoh

stopMoh(callback: (err: Error) => void): void
stopMoh(): Promise<void>

- Defined in index.d.ts:4640
Stop playing music on hold to a channel.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4645
Stop playing music on hold to a channel.

Returns Promise<void>

stopSilence

stopSilence(callback: (err: Error) => void): void
stopSilence(): Promise<void>

- Defined in index.d.ts:4662
Stop playing silence to a channel.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4667
Stop playing silence to a channel.

Returns Promise<void>

unhold

unhold(callback: (err: Error) => void): void
unhold(): Promise<void>

- Defined in index.d.ts:4605
Remove a channel from hold.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4610
Remove a channel from hold.

Returns Promise<void>

unmute

unmute(params: { direction?: string }, callback: (err: Error) => void): void
unmute(callback: (err: Error) => void): void
unmute(params?: { direction?: string }): Promise<void>

- Defined in index.d.ts:4578
Unmute a channel.

Parameters
- params: { direction?: string }
  - Optional direction?: string
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4583
Unmute a channel.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:4590
Unmute a channel.

Parameters
- Optional params: { direction?: string }
  - Optional direction?: string
Returns Promise<void>

Hierarchy

Index

Properties

Methods

Properties

accountcode

caller

Optional channelvars

connected

creationtime

dialplan

id

language

name

state

Methods

addListener

Parameters

event: "Message"

callback: (event: Message, instances: Message) => void

Parameters

event: Message

instances: Message

Returns void

Returns void

Parameters

event: "MissingParams"

callback: (event: MissingParams, instances: MissingParams) => void

Parameters

event: MissingParams

instances: MissingParams

Returns void

Returns void

Parameters

event: "Event"

callback: (event: Event, instances: Event) => void

Parameters

event: Event

instances: Event

Returns void

Returns void

Parameters

event: "ContactInfo"

callback: (event: ContactInfo, instances: ContactInfo) => void

Parameters

event: ContactInfo

instances: ContactInfo

Returns void

Returns void

Parameters

event: "Peer"

callback: (event: Peer, instances: Peer) => void

Parameters

event: Peer

instances: Peer

Returns void

Returns void

Parameters

event: "DeviceStateChanged"

callback: (event: DeviceStateChanged, devicestate: DeviceState) => void

Parameters

event: DeviceStateChanged

devicestate: DeviceState

Returns void

Returns void

Parameters

event: "PlaybackStarted"

callback: (event: PlaybackStarted, playback: Playback) => void

Parameters

event: PlaybackStarted

playback: Playback

Returns void

Returns void

Parameters

event: "PlaybackContinuing"

callback: (event: PlaybackContinuing, playback: Playback) => void

Parameters

event: PlaybackContinuing

playback: Playback

Returns void