Class: Agent

Constructors

Constructor

new Agent(name, config): Agent

Parameters

name

string

config

Returns

Agent

Properties

headers

readonly headers: Record<string, string[]>

All received INVITE headers as { name: [value, …] } (repeated headers keep every value).

metadata

readonly metadata: Record<string, unknown>

Free-form metadata attached at new Agent(...) via the metadata config field (e.g. caller.metadata.role). Empty object if none was given.

peer?

readonly optional peer?: Peer

The current call’s remote party: { uri, number, name }, or undefined.

quality?

readonly optional quality?: CallQuality

RTP media quality of the active/last call ({ mos, rtt, jitter, packetLoss }), or undefined until metrics are available (no RTCP report yet).

reason?

readonly optional reason?: string

receivedDtmf

readonly receivedDtmf: string

registered

readonly registered: boolean

state

readonly state: State

statusCode?

readonly optional statusCode?: number

Methods

abortTransfer()

abortTransfer(): void

Returns

void

accept()

accept(): void

Returns

void

attendedTransfer()

attendedTransfer(target): void

Start an attended transfer to a target: another Agent or a URI string.

Parameters

target

string | Agent

Returns

void

completeTransfer()

completeTransfer(): void

Returns

void

deflect()

deflect(target): void

Deflect inbound calls (302) to a target: another Agent or a URI / number string.

Parameters

target

string | Agent

Returns

void

dial()

dial(target): void

Dial a target: another Agent (at its AOR) or a SIP URI / number string.

Parameters

target

string | Agent

Returns

void

dtmf()

dtmf(digits, gap?): void

dtmf(digits) sends back-to-back; dtmf(digits, gap) inserts a pause (e.g. "200ms") between digits.

Parameters

digits

string

gap?

string

Returns

void

hangup()

hangup(): void

Returns

void

header(name): string | undefined

First value of a received INVITE header (a.header("X-Trace-Id")).

Parameters

name

string

Returns

string | undefined

hold()

hold(): void

Returns

void

info()

info(): AgentInfo

A snapshot of the agent’s observable state as an object. (For a JSON string, just JSON.stringify(agent.info()).)

Returns

mute()

mute(): void

Returns

void

register()

register(): void

Returns

void

respondIncoming()

respondIncoming(code, reason, headers?): void

Answer inbound INVITEs with a custom SIP response instead of accepting. respondIncoming(486, "Busy Here"), or with extra header lines: respondIncoming(302, "Moved Temporarily", { Contact: "<sip:bob@example.com>" }).

Parameters

code

number

reason

string

headers?

Record<string, string>

Returns

void

resume()

resume(): void

Returns

void

sendAudio()

sendAudio(spec): void

Set this agent’s audio source on the active call (a.sendAudio(tone(440))).

Parameters

spec

Returns

void

stopDeflect()

stopDeflect(): void

Returns

void

transfer()

transfer(target): void

Blind-transfer the current call to a target: another Agent or a URI string.

Parameters

target

string | Agent

Returns

void

verifyAudio()

verifyAudio(freq, within): Promise<void>

Assert the agent receives a freq Hz tone within within (e.g. "5s"). Returns a Promise: the blocking detection window runs on the runtime’s blocking pool, so await Promise.all([a.verifyAudio(...), b.verifyAudio(...)]) listens on several agents concurrently instead of serially.

Parameters

freq

number

within

string

Returns

Promise<void>