Channels | @types/ari-client

Hierarchy

Channels

Index

Methods

answer

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

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

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:3405
Answer a channel.

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
Returns Promise<void>

continueInDialplan

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

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

Parameters
- params: { channelId: string; context?: string; extension?: string; label?: string; priority?: number }
  - channelId: string
    
    Channels id.
  - 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:3351
Exit application; continue execution in the dialplan.

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

create

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

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

Parameters
- params: { app: string; appArgs?: string; channelId?: string; endpoint: string; formats?: string; originator?: string; otherChannelId?: string }
  - app: string
    
    Stasis Application to place channel into.
  - Optional appArgs?: string
  - Optional channelId?: 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:3207
Create channel.

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

dial

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

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

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

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

externalMedia

externalMedia(params: { app: string; channelId?: 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; channelId?: string; connection_type?: string; direction?: string; encapsulation?: string; external_host: string; format: string; transport?: string; variables?: Containers }): Promise<Channel>

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

Parameters
- params: { app: string; channelId?: 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 channelId?: string
  - 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:3930
Start an External Media session. Create a channel to an External Media source/sink.

Parameters
- params: { app: string; channelId?: 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 channelId?: string
  - 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(params: { channelId: string }, callback: (err: Error, channel: Channel) => void): void
get(params: { channelId: string }): Promise<Channel>

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

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
- 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:3229
Channel details.

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
Returns Promise<Channel>

getChannelVar

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

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

Parameters
- params: { channelId: string; variable: string }
  - channelId: string
    
    Channels id.
  - 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:3758
Get the value of a channel variable or function.

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

hangup

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

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

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

Parameters
- params: { channelId: string; reason?: string }
  - channelId: string
    
    Channels id.
  - Optional reason?: string
Returns Promise<void>

hold

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

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

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:3520
Hold a channel.

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
Returns Promise<void>

list

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

- Defined in index.d.ts:3084
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:3089
List all active channels in Asterisk.

Returns Promise<Channel[]>

move

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

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

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

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

mute

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

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

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

Parameters
- params: { channelId: string; direction?: string }
  - channelId: string
    
    Channels id.
  - Optional direction?: string
Returns Promise<void>

originate

originate(params: { app?: string; appArgs?: string; callerId?: string; channelId?: 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; channelId?: 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:3113
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; channelId?: 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 channelId?: 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:3155
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; channelId?: 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 channelId?: 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; channelId: 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; channelId: 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:3253
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; channelId: 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
  - channelId: string
    
    The unique id to assign the channel on creation.
  - 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:3295
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; channelId: 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
  - channelId: string
    
    The unique id to assign the channel on creation.
  - 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: { channelId: string; lang?: string; media: string | string[]; offsetms?: number; playbackId?: string; skipms?: number }, callback: (err: Error, playback: Playback) => void): void
play(params: { channelId: string; lang?: string; media: string | string[]; offsetms?: number; playbackId?: string; skipms?: number }): Promise<Playback>

- Defined in index.d.ts:3612
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: { channelId: string; lang?: string; media: string | string[]; offsetms?: number; playbackId?: string; skipms?: number }
  - channelId: string
    
    Channels id.
  - Optional lang?: string
  - media: string | string[]
    
    Media URIs to play.
  - Optional offsetms?: number
  - Optional playbackId?: string
  - 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:3636
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: { channelId: string; lang?: string; media: string | string[]; offsetms?: number; playbackId?: string; skipms?: number }
  - channelId: string
    
    Channels id.
  - Optional lang?: string
  - media: string | string[]
    
    Media URIs to play.
  - Optional offsetms?: number
  - Optional playbackId?: string
  - Optional skipms?: number
Returns Promise<Playback>

playWithId

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

- Defined in index.d.ts:3657
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: { channelId: string; lang?: string; media: string | string[]; offsetms?: number; playbackId: string; skipms?: number }
  - channelId: string
    
    Channels id.
  - 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:3681
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: { channelId: string; lang?: string; media: string | string[]; offsetms?: number; playbackId: string; skipms?: number }
  - channelId: string
    
    Channels id.
  - 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; channelId: string; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }, callback: (err: Error, liverecording: LiveRecording) => void): void
record(params: { beep?: boolean; channelId: string; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }): Promise<LiveRecording>

- Defined in index.d.ts:3703
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; channelId: string; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }
  - Optional beep?: boolean
  - channelId: string
    
    Channels id.
  - format: string
    
    Format to encode audio in.
  - Optional ifExists?: string
  - Optional maxDurationSeconds?: number
  - Optional maxSilenceSeconds?: number
  - name: string
    
    Recordings filename.
  - Optional terminateOn?: string
- 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:3730
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; channelId: string; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }
  - Optional beep?: boolean
  - channelId: string
    
    Channels id.
  - format: string
    
    Format to encode audio in.
  - Optional ifExists?: string
  - Optional maxDurationSeconds?: number
  - Optional maxSilenceSeconds?: number
  - name: string
    
    Recordings filename.
  - Optional terminateOn?: string
Returns Promise<LiveRecording>

redirect

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

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

Parameters
- params: { channelId: string; endpoint: string }
  - channelId: string
    
    Channels id.
  - 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:3391
Redirect the channel to a different location.

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

ring

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

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

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:3419
Indicate ringing to a channel.

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
Returns Promise<void>

ringStop

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

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

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:3433
Stop ringing indication on a channel if locally generated.

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
Returns Promise<void>

rtpstatistics

rtpstatistics(params: { channelId: string }, callback: (err: Error, rtpstat: RTPstat) => void): void
rtpstatistics(params: { channelId: string }): Promise<RTPstat>

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

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
- 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:3883
RTP stats on a channel.

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
Returns Promise<RTPstat>

sendDTMF

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

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

Parameters
- params: { after?: number; before?: number; between?: number; channelId: string; dtmf?: string; duration?: number }
  - Optional after?: number
  - Optional before?: number
  - Optional between?: number
  - channelId: string
    
    Channels id.
  - 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:3467
Send provided DTMF to a given channel.

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

setChannelVar

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

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

Parameters
- params: { channelId: string; value?: string; variable: string }
  - channelId: string
    
    Channels id.
  - 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:3779
Set the value of a channel variable or function.

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

snoopChannel

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

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

Parameters
- params: { app: string; appArgs?: string; channelId: string; snoopId?: string; spy?: string; whisper?: string }
  - app: string
    
    Application the snooping channel is placed into.
  - Optional appArgs?: string
  - channelId: string
    
    Channels id.
  - Optional snoopId?: string
  - 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:3808
Start snooping. Snoop (spy/whisper) on a specific channel.

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

snoopChannelWithId

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

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

Parameters
- params: { app: string; appArgs?: string; channelId: string; snoopId: string; spy?: string; whisper?: string }
  - app: string
    
    Application the snooping channel is placed into.
  - Optional appArgs?: string
  - channelId: string
    
    Channels id.
  - 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:3844
Start snooping. Snoop (spy/whisper) on a specific channel.

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

startMoh

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

- Defined in index.d.ts:3544
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: { channelId: string; mohClass?: string }
  - channelId: string
    
    Channels id.
  - Optional mohClass?: string
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:3554
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: { channelId: string; mohClass?: string }
  - channelId: string
    
    Channels id.
  - Optional mohClass?: string
Returns Promise<void>

startSilence

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

- Defined in index.d.ts:3576
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
- params: { channelId: string }
  - channelId: string
    
    Channels id.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:3584
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
- params: { channelId: string }
  - channelId: string
    
    Channels id.
Returns Promise<void>

stopMoh

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

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

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:3568
Stop playing music on hold to a channel.

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
Returns Promise<void>

stopSilence

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

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

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:3598
Stop playing silence to a channel.

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
Returns Promise<void>

unhold

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

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

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:3534
Remove a channel from hold.

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
Returns Promise<void>

unmute

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

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

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

Parameters
- params: { channelId: string; direction?: string }
  - channelId: string
    
    Channels id.
  - Optional direction?: string
Returns Promise<void>

Hierarchy

Index

Methods

Methods

answer

Parameters

params: { channelId: string }

channelId: string

callback: (err: Error) => void

Parameters

err: Error

Returns void

Returns void

Parameters

params: { channelId: string }

channelId: string

Returns Promise<void>

continueInDialplan

Parameters

params: { channelId: string; context?: string; extension?: string; label?: string; priority?: number }

channelId: string

Optional context?: string

Optional extension?: string

Optional label?: string

Optional priority?: number

callback: (err: Error) => void

Parameters

err: Error

Returns void

Returns void

Parameters

params: { channelId: string; context?: string; extension?: string; label?: string; priority?: number }

channelId: string

Optional context?: string

Optional extension?: string

Optional label?: string

Optional priority?: number

Returns Promise<void>

create

Parameters

params: { app: string; appArgs?: string; channelId?: string; endpoint: string; formats?: string; originator?: string; otherChannelId?: string }

app: string

Optional appArgs?: string

Optional channelId?: string

endpoint: string

Optional formats?: string

Optional originator?: string

Optional otherChannelId?: string

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

Parameters

err: Error

channel: Channel

Returns void

Returns void

Parameters

params: { app: string; appArgs?: string; channelId?: string; endpoint: string; formats?: string; originator?: string; otherChannelId?: string }

app: string

Optional appArgs?: string

Optional channelId?: string

endpoint: string

Optional formats?: string

Optional originator?: string

Optional otherChannelId?: string

Returns Promise<Channel>

dial

Parameters

params: { caller?: string; channelId: string; timeout?: number }

Optional caller?: string

channelId: string

Optional timeout?: number

callback: (err: Error) => void

Parameters

err: Error

Returns void

Returns void

Parameters

params: { caller?: string; channelId: string; timeout?: number }

Optional caller?: string

channelId: string

Optional timeout?: number