Class Channel

Represents an AGI Channel

Hierarchy

EventEmitter
- Channel

Index

Constructors

constructor

Constructors

constructor

new Channel(connection: Socket): Channel
Creates a new instance of a channel object
Parameters
- connection: Socket
  the AGI socket connection
Returns Channel
Overrides EventEmitter.constructor

Accessors

accountcode

get accountcode(): string
Account code of the origin channel

Returns string

autoCloseOnHangup

get autoCloseOnHangup(): boolean
Gets the value of the close on hangup setting

Returns boolean
set autoCloseOnHangup(value: boolean): void
Gets the value of the close on hangup setting
Parameters
- value: boolean
Returns void

callerid

get callerid(): string
The caller ID number (or “unknown”)

Returns string

calleridname

get calleridname(): string
The caller ID name (or “unknown”)

Returns string

callingani2

get callingani2(): string
The number which is defined in ANI2 see Asterisk Detailed Variable List (only for PRI Channels)

Returns string

callingpres

get callingpres(): string
The presentation for the callerid in a ZAP channel

Returns string

callingtns

get callingtns(): string
An optional 4-digit number (Transit Network Selector) used in PRI Channels see Asterisk Detailed Variable List

Returns string

callington

get callington(): string
The type of number used in PRI Channels see Asterisk Detailed Variable List

Returns string

channel

get channel(): string
The originating channel (your phone)

Returns string

context

get context(): string
Origin context in extensions.conf

Returns string

dnid

get dnid(): string
The dialed number id (or “unknown”)

Returns string

enhanced

get enhanced(): string
The flag value is 1.0 if started as an EAGI script, 0.0 otherwise

Returns string

extension

get extension(): string
The called number

Returns string

language

get language(): string
The language code (e.g. “en”)

Returns string

network

get network(): boolean
Whether this AGI request is over the network

Returns boolean

network_script

get network_script(): string
The network path included in the AGI request e.g. agi://127.0.0.1:3000/test This value would return 'test'

Returns string

outgoingHeaders

get outgoingHeaders(): Record<string, string>
Headers that have been set for outgoing requests

Returns Record<string, string>

priority

get priority(): string
The priority it was executed as in the dial plan

Returns string

rdnis

get rdnis(): string
The referring DNIS number (or “unknown”)

Returns string

remoteIP

get remoteIP(): string
Gets the IP address of the Asterisk Server that initiated the channel

Returns string

request

get request(): string
The filename of your script ie. agi

Returns string

threadid

get threadid(): string
Thread ID of the AGI script

Returns string

type

get type(): Driver
The originating channel type (e.g. “SIP” or “ZAP”)

Returns Driver

uniqueid

get uniqueid(): string
A unique ID for the call

Returns string

version

get version(): string
The version of Asterisk

Returns string

Methods

addHeader

addHeader(key: string, value: string): Promise<void>
Adds a header to the outgoing request
Parameters
- key: string
- value: string
Returns Promise<void>

answer

answer(): Promise<void>
Answers channel if not already in answer state.

Returns Promise<void>

break

break(): Promise<void>
Interrupts expected flow of Async AGI commands and returns control to previous source (typically, the PBX dialplan).

Returns Promise<void>

busy

busy(timeout?: number): Promise<number>
Indicates busy to the calling channel
Parameters
- Optionaltimeout: number
  if specified, the calling channel will be hung up after the specified number of seconds. Otherwise, this application will wait until the calling channel hangs up
Returns Promise<number>

channelStatus

channelStatus(channel?: string): Promise<State>
Returns status of the connected channel.
Parameters
- Optionalchannel: string
Returns Promise<State>

congestion

congestion(timeout?: number): Promise<number>
Indicates congestion to the calling channel
Parameters
- Optionaltimeout: number
  if specified, the calling channel will be hung up after the specified number of seconds. Otherwise, this application will wait until the calling channel hangs up
Returns Promise<number>

controlStreamFile

controlStreamFile(
    filename: string,
    escapeDigits?: string,
    skipms?: number,
    fastForwardCharacter?: string,
    rewindCharacter?: string,
    pauseCharacter?: string,
): Promise<
    {
        digit: string;
        playbackOffset: number;
        playbackStatus: Channel.Playback.Status;
    },
>
Sends audio file on channel and allows the listener to control the stream.
Parameters
- filename: string
- escapeDigits: string = ''
- Optionalskipms: number
- OptionalfastForwardCharacter: string
- OptionalrewindCharacter: string
- OptionalpauseCharacter: string
Returns Promise<
    {
        digit: string;
        playbackOffset: number;
        playbackStatus: Channel.Playback.Status;
    },
>

databaseDel

databaseDel(family: string, key: string): Promise<void>
Deletes an entry in the Asterisk database for a given family and key.
Parameters
- family: string
- key: string
Returns Promise<void>

databaseDelTree

databaseDelTree(family: string, keyTree?: string): Promise<boolean>
Deletes a family or specific keytree within a family in the Asterisk database.
Parameters
- family: string
- OptionalkeyTree: string
Returns Promise<boolean>

databaseGet

databaseGet(family: string, key: string): Promise<string>
Retrieves an entry in the Asterisk database for a given family and key.
Parameters
- family: string
- key: string
Returns Promise<string>

databasePut

databasePut(family: string, key: string, value: string): Promise<string>
Adds or updates an entry in the Asterisk database for a given family, key, and value.
Parameters
- family: string
- key: string
- value: string
Returns Promise<string>

dial

dial(
    target: string,
    options?: Partial<
        { hangupOnComplete: boolean; params: string; timeout: number },
    >,
): Promise<
    {
        answered_time: number;
        dialed_time: number;
        peer_name: string;
        peer_number: string;
        progress_time: number;
        ring_time: number;
        status: Channel.Dial.Status;
    },
>
Attempts to establish a new outgoing connection on a channel, and then link it to the calling input channel.
Parameters
- target: string
- options: Partial<{ hangupOnComplete: boolean; params: string; timeout: number }> = {}
Returns Promise<
    {
        answered_time: number;
        dialed_time: number;
        peer_name: string;
        peer_number: string;
        progress_time: number;
        ring_time: number;
        status: Channel.Dial.Status;
    },
>

exec

exec(application: string, ...args: string[]): Promise<number>
Executes application with given options
Parameters
- application: string
- ...args: string[]
Returns Promise<number>

getData

getData(
    soundFile: string,
    timeout?: number,
    maxDigits?: number,
): Promise<{ digits: string; timeout: boolean }>
Stream the given file, and receive DTMF data.
Parameters
- soundFile: string
- timeout: number = 5
- OptionalmaxDigits: number
Returns Promise<{ digits: string; timeout: boolean }>

getFullVariable

getFullVariable(
    key: string,
    channel?: string,
    keyToUpper?: boolean,
): Promise<string>
Evaluates a channel expression Understands complex variable names and builtin variables, unlike GET VARIABLE.
Parameters
- key: string
- Optionalchannel: string
- keyToUpper: boolean = true
Returns Promise<string>

getFullVariableRaw

getFullVariableRaw(key: string, channel?: string): Promise<string>
Evaluates a channel expression Understands complex variable names and builtin variables, unlike GET VARIABLE.
Parameters
- key: string
- Optionalchannel: string
Returns Promise<string>

getHeader

getHeader(key: string): Promise<undefined | string>
Attempts to retrieve the inbound header specified from the channel

Note: This method can only read headers on the incoming request. It can not read headers set on an outbound SIP request.
Parameters
- key: string
Returns Promise<undefined | string>

getOption

getOption(
    soundFile: string,
    escapeDigits?: string,
    timeout?: number,
): Promise<{ digit: string; endpos: number }>
Stream file, prompt for DTMF, with timeout. Behaves similar to STREAM FILE but used with a timeout option.
Parameters
- soundFile: string
- escapeDigits: string = '#'
- timeout: number = 5
Returns Promise<{ digit: string; endpos: number }>

getVariable

getVariable(key: string, keyToUpper?: boolean): Promise<string>
Gets a channel variable.
Parameters
- key: string
- keyToUpper: boolean = true
  whether to force the key to uppercase
Returns Promise<string>

goSub

goSub(
    context: string,
    extension: string,
    priority: number,
    argument?: string,
): Promise<void>
Cause the channel to execute the specified dialplan subroutine.
Parameters
- context: string
- extension: string
- priority: number
- Optionalargument: string
Returns Promise<void>

hangup

hangup(channel?: string): Promise<void>
Hangs up the specified channel. If no channel name is given, hangs up the current channel
Parameters
- Optionalchannel: string
Returns Promise<void>

noop

noop(): Promise<void>
Does nothing

Returns Promise<void>

on

on(event: "error", listener: (error: any) => void): this
Event that is emitted when the underlying socket encounters an error
Parameters
- event: "error"
- listener: (error: any) => void
Returns this
Overrides EventEmitter.on
on(event: "close", listener: () => void): this
Event that is emitted when the underlying socket is closed
Parameters
- event: "close"
- listener: () => void
Returns this
Overrides EventEmitter.on
on(event: "timeout", listener: () => void): this
Event that emitted when the underlying socket times out
Parameters
- event: "timeout"
- listener: () => void
Returns this
Overrides EventEmitter.on
on(event: "ready", listener: () => void): this
Event that is emitted when the channel is ready
Parameters
- event: "ready"
- listener: () => void
Returns this
Overrides EventEmitter.on
on(event: "recv", listener: (response: string) => void): this
Event that is emitted when a response is received from the Asterisk server
Parameters
- event: "recv"
- listener: (response: string) => void
Returns this
Overrides EventEmitter.on
on(event: "hangup", listener: () => void): this
Event that emitted when the channel is hung up
Parameters
- event: "hangup"
- listener: () => void
Returns this
Overrides EventEmitter.on
on(event: "response", listener: (response: Response) => void): this
Event that emitted when the response from the Asterisk server is processed into a structured response
Parameters
- event: "response"
- listener: (response: Response) => void
Returns this
Overrides EventEmitter.on
on(event: "send", listener: (data: string) => void): this
Event that is emitted when data is sent to the Asterisk server
Parameters
- event: "send"
- listener: (data: string) => void
Returns this
Overrides EventEmitter.on

progress

progress(): Promise<number>
Requests that in-band progress information be provided to the calling channel

Returns Promise<number>

receiveChar

receiveChar(timeout?: number): Promise<{ char: string; timeout: boolean }>
Receives one character from channels supporting it.
Parameters
- timeout: number = 5
Returns Promise<{ char: string; timeout: boolean }>

receiveText

receiveText(timeout?: number): Promise<string>
Receives text from channels supporting it.
Parameters
- timeout: number = 5
Returns Promise<string>

recordFile

recordFile(
    filename: string,
    fileFormat?: string,
    escapeDigits?: string,
    timeout?: number,
    beep?: boolean,
    silence?: number,
    offsetSamples?: number,
): Promise<{ digit: string; endpos: number; timeout: boolean }>
Records to a given file.
Parameters
- filename: string
- fileFormat: string = 'gsm'
- escapeDigits: string = '#'
- timeout: number = 10
- Optionalbeep: boolean
- Optionalsilence: number
- OptionaloffsetSamples: number
Returns Promise<{ digit: string; endpos: number; timeout: boolean }>

removeHeader

removeHeader(key: string): Promise<void>
Allows you to remove a header from the outgoing request as long as you have added it via the addHeader() method.
Parameters
- key: string
Returns Promise<void>

ringing

ringing(): Promise<number>
Requests that the channel indicate a ringing tone to the user

Returns Promise<number>

sayAlpha

sayAlpha(value: string, escapeDigits?: string): Promise<string>
Says a given character string.
Parameters
- value: string
- escapeDigits: string = '#'
Returns Promise<string>

sayDate

sayDate(value: number | Date, escapeDigits?: string): Promise<string>
Says a given date.
Parameters
- value: number | Date
- escapeDigits: string = '#'
Returns Promise<string>

sayDateTime

sayDateTime(
    value: number | Date,
    escapeDigits?: string,
    dateFormat?: string,
    timezone?: string,
): Promise<string>
Says a given time as specified by the format given.
Parameters
- value: number | Date
- escapeDigits: string = '#'
- OptionaldateFormat: string
- Optionaltimezone: string
Returns Promise<string>

sayDigits

sayDigits(value: string, escapeDigits?: string): Promise<string>
Says a given digit string.
Parameters
- value: string
- escapeDigits: string = '#'
Returns Promise<string>

sayNumber

sayNumber(value: number, escapeDigits?: string): Promise<string>
Says a given number.
Parameters
- value: number
- escapeDigits: string = '#'
Returns Promise<string>

sayPhonetic

sayPhonetic(value: string, escapeDigits?: string): Promise<string>
Says a given character string with phonetics.
Parameters
- value: string
- escapeDigits: string = '#'
Returns Promise<string>

sayTime

sayTime(value: number | Date, escapeDigits?: string): Promise<string>
Says a given time.
Parameters
- value: number | Date
- escapeDigits: string = '#'
Returns Promise<string>

sendImage

sendImage(image: string): Promise<void>
Sends images to channels supporting it.
Parameters
- image: string
Returns Promise<void>

sendText

sendText(text: string): Promise<void>
Sends text to channels supporting it.
Parameters
- text: string
Returns Promise<void>

setAutoHangup

setAutoHangup(timeout?: number): Promise<void>
Autohangup channel in some time.
Parameters
- timeout: number = 60
Returns Promise<void>

setCallerID

setCallerID(callerNumber: number, callerName?: string): Promise<void>
Sets callerid for the current channel.
Parameters
- callerNumber: number
- OptionalcallerName: string
Returns Promise<void>

setContext

setContext(context: string): Promise<void>
Sets channel context.
Parameters
- context: string
Returns Promise<void>

setExtension

setExtension(extension: string): Promise<void>
Changes channel extension.
Parameters
- extension: string
Returns Promise<void>

setMusic

setMusic(status?: boolean, musicClass?: string): Promise<void>
Enable/Disable Music on hold generator
Parameters
- status: boolean = true
- OptionalmusicClass: string
Returns Promise<void>

setPriority

setPriority(priority: number): Promise<void>
Set channel dialplan priority.
Parameters
- priority: number
Returns Promise<void>

setVariable

setVariable(key: string, value: string): Promise<void>
Set channel dialplan priority.
Parameters
- key: string
- value: string
Returns Promise<void>

speechActivateGrammar

speechActivateGrammar(grammar: string): Promise<Response>
Parameters
- grammar: string
Returns Promise<Response>

speechCreate

speechCreate(engine: string): Promise<Response>
Parameters
- engine: string
Returns Promise<Response>

speechDeactivateGrammar

speechDeactivateGrammar(grammar: string): Promise<Response>
Parameters
- grammar: string
Returns Promise<Response>

speechDestroy

speechDestroy(): Promise<Response>
Returns Promise<Response>

speechLoadGrammar

speechLoadGrammar(grammar: string, path: string): Promise<Response>
Parameters
- grammar: string
- path: string
Returns Promise<Response>

speechRecognize

speechRecognize(
    soundFile: string,
    timeout?: number,
    offset: number,
): Promise<Response>
Parameters
- soundFile: string
- timeout: number = 5
- offset: number
Returns Promise<Response>

speechSet

speechSet(key: string, value: string): Promise<Response>
Parameters
- key: string
- value: string
Returns Promise<Response>

speedUnloadGrammar

speedUnloadGrammar(grammar: string): Promise<Response>
Parameters
- grammar: string
Returns Promise<Response>

streamFile

streamFile(
    filename: string,
    escapeDigits?: string,
    offset?: number,
): Promise<{ digit: string; endpos: number }>
Sends audio file on channel.
Parameters
- filename: string
- escapeDigits: string = '#'
- Optionaloffset: number
Returns Promise<{ digit: string; endpos: number }>

tddMode

tddMode(status: boolean): Promise<void>
Toggles TDD mode (for the deaf).
Parameters
- status: boolean
Returns Promise<void>

verbose

verbose(message: string, level?: number): Promise<void>
Logs a message to the asterisk verbose log.
Parameters
- message: string
- Optionallevel: number
Returns Promise<void>

waitForDigit

waitForDigit(timeout?: number): Promise<string>
Waits for a digit to be pressed.
Parameters
- timeout: number = 5
Returns Promise<string>

Class Channel

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Channel

Accessors

accountcode

Returns string

autoCloseOnHangup

Returns boolean

Parameters

Returns void

callerid

Returns string

calleridname

Returns string

callingani2

Returns string

callingpres

Returns string

callingtns

Returns string

callington

Returns string

channel

Returns string

context

Returns string

dnid

Returns string

enhanced

Returns string

extension

Returns string

language

Returns string

network

Returns boolean

network_script

Returns string

outgoingHeaders

Returns Record<string, string>

priority

Returns string

rdnis

Returns string

remoteIP

Returns string

request

Returns string

threadid

Returns string

type

Returns Driver

uniqueid

Returns string

version

Returns string

Methods

addHeader

Parameters

Returns Promise<void>

answer

Returns Promise<void>

break

Returns Promise<void>

busy

Parameters

Returns Promise<number>

channelStatus

Parameters

Returns Promise<State>

congestion

Parameters

Returns Promise<number>

Returns Promise<
{
digit: string;
playbackOffset: number;
playbackStatus: Channel.Playback.Status;
},
>

Returns Promise<
{
answered_time: number;
dialed_time: number;
peer_name: string;
peer_number: string;
progress_time: number;
ring_time: number;
status: Channel.Dial.Status;
},
>