Interface: AgentConfig

Properties

auth_user?

optional auth_user?: string

auth user, if it differs from username.

deflect_to?

optional deflect_to?: string

deflect inbound calls with a 302 to this URI/number.

display_name?

optional display_name?: string

caller display name.

domain

domain: string

SIP domain / registrar. Required.

dtmf_mode?

optional dtmf_mode?: string

"info" for reliable headless DTMF (SIP INFO).

headers?

optional headers?: Record<string, string | string[]>

({ "X-Foo": ["a", "b"] }) sends the header repeated, once per element.

media_enc?

optional media_enc?: string

media encryption, e.g. srtp, zrtp, dtls_srtp.

metadata?

optional metadata?: Record<string, unknown>

(e.g. { role: "caller" }); not used for SIP.

mwi?

optional mwi?: boolean

subscribe to message-waiting indication.

outbound?

optional outbound?: string

outbound proxy URI.

password?

optional password?: string

Auth password.

regint?

optional regint?: number

re-registration interval (seconds); 0 disables.

stun_server?

optional stun_server?: string

STUN server, e.g. stun:host:port.

transport?

optional transport?: string

udp (default), tcp or tls.

username

username: string

SIP user (registration / auth). Required.