Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace <internal>

Index

Classes

Type aliases

Type aliases

Account

Account: { enabled: boolean; id: AccountId; name: string; registered: boolean; type: AccountType }

Type declaration

AccountEvents

AccountEvents: { accountCreate: any; accountRemove: any; accountUpdate: any }

Type declaration

AccountId

AccountId: number

AccountType

AccountType: "sip" | "xmpp"

AudioDevice

AudioDevice: { id: number; name: string; roles?: AudioDeviceRole[]; selected?: boolean; type: AudioDeviceType }

Type declaration

AudioDeviceRole

AudioDeviceRole: "headset" | "speakerPhone" | "ringOn"

AudioDeviceType

AudioDeviceType: "input" | "output"

AudioProperties

AudioProperties: { microphoneVolume: number; mute: boolean; speaker: boolean; speakerMute: boolean; speakerVolume: number }

Type declaration

  • microphoneVolume: number
  • mute: boolean

    Microphone mute state

  • speaker: boolean

    Speakerphone mode state

  • speakerMute: boolean

    Sound output mute state

  • speakerVolume: number

AudioTypes

AudioTypes: { devicesUpdated: any; propertiesUpdated: any }

Type declaration

  • devicesUpdated:function
    • devicesUpdated(devices: AudioDevice[]): void | Promise<void>
  • propertiesUpdated:function
    • propertiesUpdated(): void | Promise<void>

AuthEvents

AuthEvents: { authenticationUpdate: any }

Type declaration

AuthResponse

AuthResponse: { authenticated: boolean; notAuthenticatedReason?: string; serverProvidedReason?: string }

Type declaration

  • authenticated: boolean
  • Optional notAuthenticatedReason?: string
  • Optional serverProvidedReason?: string

BriaClientEvents

BriaClientEvents: { statusChange.authentication: BriaClientStatusChangeEvent; statusChange.call: BriaClientStatusChangeEvent; statusChange.callHistory: BriaClientStatusChangeEvent; statusChange.callOptions: BriaClientStatusChangeEvent; statusChange.phone: BriaClientStatusChangeEvent; statusChange.voicemail: BriaClientStatusChangeEvent; close: any; error: any; open: any; ready: any; reconnect: any; warn: any }

Type declaration

BriaClientOptions

BriaClientOptions: { apiUrl?: string; autoReconnect?: boolean; autoReconnectAttempts?: number; autoReconnectDelay?: number; populateChildren?: boolean; populateVersion?: boolean; rejectUnauthorized?: boolean; userAgent?: string }

Type declaration

  • Optional apiUrl?: string

    Bria WebSocket URL Default is 'wss://cpclientapi.softphone.com:9002/counterpath/socketapi/v1'

  • Optional autoReconnect?: boolean
  • Optional autoReconnectAttempts?: number
  • Optional autoReconnectDelay?: number

    Delay before reopening the WebSocket (in milliseconds)

  • Optional populateChildren?: boolean

    Automatically populate the client's children's properties Default TRUE, this will request API access as soon as connected If false, it will only populate data on-demand (on event/method calls)

  • Optional populateVersion?: boolean

    Automatically populate the version information on connection Default TRUE, this will request API access as soon as connected If false, you won't be able to use old Bria versions with the wrapper.

  • Optional rejectUnauthorized?: boolean

    Ignore invalid certificates Default FALSE (insecure!!) because the Desktop API does not include valid intermediate certificates in the chain.

  • Optional userAgent?: string

BriaClientStatusChangeEvent

BriaClientStatusChangeEvent: (xml: sxml.XML, rawData: string) => Promise<void> | void

Type declaration

    • (xml: sxml.XML, rawData: string): Promise<void> | void

    • Parameters

      • xml: sxml.XML

        XML response from simplexml (sxml), if any

      • rawData: string

        Raw response string from Bria

      Returns Promise<void> | void

BriaClientVersion

BriaClientVersion: { systemCompanyName: string; systemProductBuild: number; systemProductName: string; systemProductVersion: string }

Type declaration

  • systemCompanyName: string
  • systemProductBuild: number
  • systemProductName: string
  • systemProductVersion: string

Call

Call: { accountId?: string; displayName?: string; number: CallNumber; suppressMainWindow?: boolean; type: CallType }

Type declaration

  • Optional accountId?: string
  • Optional displayName?: string
  • number: CallNumber
  • Optional suppressMainWindow?: boolean

    If true, the Bria window will not regain focus when call is initiated

  • type: CallType

CallEvents

CallEvents: { callEnd: any; callStart: any; callUpdate: any; optionsUpdated: any }

Type declaration

  • callEnd:function
    • callEnd(call: BriaCall, id: string): void | Promise<void>
  • callStart:function
    • callStart(call: BriaCall, id: string): void | Promise<void>
  • callUpdate:function
    • callUpdate(call: BriaCall, id: string): void | Promise<void>
  • optionsUpdated:function
    • optionsUpdated(): void | Promise<void>

CallNumber

CallNumber: string

CallOptions

CallOptions: { anonymous: boolean; autoAnswer: boolean; callWaiting: boolean; lettersToNumbers: boolean }
see

https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHandlingCalls.htm#getStatusCallOptions

Type declaration

  • anonymous: boolean
  • autoAnswer: boolean
  • callWaiting: boolean
  • lettersToNumbers: boolean

CallParty

CallParty: { displayName: string; number: CallNumber; state: CallState; timeInitiated: Date }

Type declaration

CallState

CallState: "connected" | "connecting" | "ringing" | "failed" | "ended"

CallType

CallType: "audio" | "video" | "conference"

Contact

Contact: { collabUrl: string[]; email: string[]; fax: string[]; home: string[]; id: ContactId; jid: string[]; mobile: string[]; other: string[]; presenceAddress: string; presenceStatus: PresenceType; presenceText: string; presenceType: AccountType; softphone: string[]; website: string[]; work: string[] }

Type declaration

  • collabUrl: string[]
  • email: string[]
  • fax: string[]
  • home: string[]
  • id: ContactId
  • jid: string[]
  • mobile: string[]
  • other: string[]
  • presenceAddress: string
  • presenceStatus: PresenceType
  • presenceText: string
  • presenceType: AccountType
  • softphone: string[]
  • website: string[]
  • work: string[]

ContactId

ContactId: number

DTMFDigit

DTMFDigit: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "*" | "#"

DTMFType

DTMFType: "start" | "stop"

HistoryEntry

HistoryEntry: { accountId: AccountId; callEnd: Date; displayName: string; duration: number; id: string; number: string; timeInitiated: Date; type: HistoryEntryType }

Type declaration

  • accountId: AccountId
  • callEnd: Date
  • displayName: string
  • duration: number
  • id: string
  • number: string
  • timeInitiated: Date
  • type: HistoryEntryType

HistoryEntryType

HistoryEntryType: "missed" | "received" | "dialed"

HistoryEvents

HistoryEvents: { historyUpdated: any }

Type declaration

  • historyUpdated:function
    • historyUpdated(): void | Promise<void>

HistoryType

HistoryType: "all" | "missed"

HoldState

HoldState: "offHold" | "localHold" | "remoteHold"

PhoneAccountStatus

PhoneAccountStatus: "connected" | "connecting" | "failureContactingServer" | "failureAtServer" | "disabled"

PhoneCallState

PhoneCallState: "allow" | "notAllow"

PhoneState

PhoneState: "ready" | "notReady"

PhoneStatus

PhoneStatus: { accountFailureCode: number; accountStatus: PhoneAccountStatus; call: PhoneCallState; maxLines: number; state: PhoneState }

Type declaration

Presence

Presence: { status: PresenceType; text: string }

Type declaration

PresenceType

PresenceType: "available" | "busy" | "away" | "onThePhone" | "notAvailableForCalls" | "doNotDisturb" | "offline"

ScreenShareInvitee

ScreenShareInvitee: { address: string; type: ScreenShareInviteeType }

Type declaration

ScreenShareInviteeType

ScreenShareInviteeType: "xmpp" | "simple"

ScreenShareSession

ScreenShareSession: { joinUrl: string; status: string }

Type declaration

  • joinUrl: string
  • status: string

SystemInformationResponse

SystemInformationResponse: { systemCompanyName: string; systemProductBuild: number; systemProductName: string; systemProductVersion: string }

Type declaration

  • systemCompanyName: string
  • systemProductBuild: number
  • systemProductName: string
  • systemProductVersion: string

SystemSettingsResponse

SystemSettingsResponse: { callRightAwayOnceNumberSelected: boolean; defaultCallType: CallType }

Type declaration

  • callRightAwayOnceNumberSelected: boolean

    If false, user must manually press Call in the UI before call is placed after GET /call (client.calls) If true, call is placed immediately

  • defaultCallType: CallType

Voicemail

Voicemail: { accountId: AccountId; accountName: string; count: number }

Type declaration

  • accountId: AccountId
  • accountName: string
  • count: number

VoicemailEvents

VoicemailEvents: { voicemailUpdate: any }

Type declaration

Generated using TypeDoc