Skip to main content

​
Interface: CredentialConfig

Defined in: models/config.ts:4 Configuration for credential-based authentication

​
Properties

​
type

type: "credential"
Defined in: models/config.ts:5

​
sipUser

sipUser: string
Defined in: models/config.ts:6

​
sipPassword

sipPassword: string
Defined in: models/config.ts:7

​
debug?

optional debug: boolean
Defined in: models/config.ts:8 Enable WebSocket-based debug stats collection. When enabled, the SDK sends real-time WebRTC statistics to the Telnyx debug service over the WebSocket connection. Default: false

​
pushNotificationDeviceToken?

optional pushNotificationDeviceToken: string
Defined in: models/config.ts:9

​
enableCallReports?

optional enableCallReports: boolean
Defined in: models/config.ts:11 Enable automatic call quality reporting. When enabled, the SDK collects WebRTC stats and structured logs during calls and POSTs them to the /call_report endpoint when calls end. Default: true

​
callReportInterval?

optional callReportInterval: number
Defined in: models/config.ts:13 Stats collection interval in seconds. Default: 5

​
callReportLogLevel?

optional callReportLogLevel: string
Defined in: models/config.ts:15 Minimum log level to capture for call reports: 'debug' | 'info' | 'warn' | 'error'. Default: 'debug'

​
callReportMaxLogEntries?

optional callReportMaxLogEntries: number
Defined in: models/config.ts:17 Maximum number of log entries to buffer per call. Default: 1000