Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AgentConfiguration

Hierarchy

  • AgentConfiguration

Index

Properties

Properties

Optional customSipHeaders

customSipHeaders?: CustomSipHeaders

Object for customizing SIP headers

Optional debug

debug?: number | boolean | ((level: number, ...values: any[]) => unknown)

If debug is set to true, verbose log messages will be printed to the console
If debug is set to a LogLevel bitmask, specified log messages will be printed to the console
If debug is set to a callback, this callback will be called for each debug statement

Optional displayName

displayName?: string

The user's well known identity.
Providing a display name is HIGHLY RECOMMENDED!
Examples:

  • the user's name (Alice)
  • the user's telephone number (+43664123456789)
  • an arbitrary identification of the user (Anonymous)

domain

domain: string

The domain used as realm in SIP

endpoint

endpoint: string

The websocket endpoint of the SIP proxy the agent should connect to

Optional namespaceSpecifics

namespaceSpecifics?: NamespaceSpecifics

Configuration object for cross compatibility between ETSI and DEC112 environments.
Currently, only DEC112Specifics is supported.
ETSI environments don't need a special configuration object

password

password: string

The user's password for connecting to the SIP proxy

user

user: string

The user's identity for connecting to the SIP proxy

Optional userAgentConfig

userAgentConfig?: Partial<UAConfiguration>

Additional parameters to pass to the JsSIP user agent

Generated using TypeDoc