Class: BicomSDK
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:126
Implements
BicomSDK
Constructors
Constructor
new BicomSDK():
BicomSDK
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:127
Returns
BicomSDK
Accessors
emitter
Get Signature
get emitter():
EventEmitter
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:687
Returns an event emitter instance for this Bicom SDK, providing access to its connection events and other relevant signals.
Returns
EventEmitter
Implementation of
BicomSDKInterface.emitter
profileInfo
Get Signature
get profileInfo():
ProfileInfo
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:845
Returns profile info created from login response
Returns
Implementation of
BicomSDKInterface.profileInfo
pwpServiceConnectionState
Get Signature
get pwpServiceConnectionState():
PwpServiceConnectionState
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:691
Gets the current sdk service component connection state of the Bicom SDK.
Returns
The current sdk service component connection state of the Bicom SDK.
Implementation of
BicomSDKInterface.pwpServiceConnectionState
sipServiceConnectionState
Get Signature
get sipServiceConnectionState():
SipServiceConnectionState
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:695
Gets the current sip service component connection state of the Bicom SDK.
Returns
The current sip service component connection state of the Bicom SDK.
Implementation of
BicomSDKInterface.sipServiceConnectionState
Methods
addIntoCall()
addIntoCall(
callId,calls,numbers):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:828
Adds calls and numbers into call
Parameters
callId
string
desired call callId
calls
string[]
numbers
string[]
Returns
void
Implementation of
BicomSDKInterface.addIntoCall
answerCall()
answerCall(
callId,audioElement?):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:501
Parameters
callId
string
audioElement?
HTMLAudioElement
Returns
void
cancelSupervisedTransfer()
cancelSupervisedTransfer(
callId):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:642
Cancels supervised transfer for call
Parameters
callId
string
The ID of the call to send transfer.
Returns
void
Throws
If the callId or digit is not provided.
Throws
If the SDK is not connected before attempting to send DTMF.
Throws
If call to transfer is not found
Implementation of
BicomSDKInterface.cancelSupervisedTransfer
changePresenceStatus()
changePresenceStatus(
statusCode,expiration?,statusMessage?):Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1036
Change presence status of currently logged in user
Parameters
statusCode
status code to change status to
expiration?
number
optional status expiration in minutes (by default status expiration is set to 0 which effectively means indefinitely)
statusMessage?
string
optional status message
Returns
Promise<void>
Implementation of
BicomSDKInterface.changePresenceStatus
clearCallHistory()
clearCallHistory():
Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1113
Clears call history
Returns
Promise<void>
Implementation of
BicomSDKInterface.clearCallHistory
completeSupervisedTransfer()
completeSupervisedTransfer(
callId):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:628
Completes supervised transfer for call
Parameters
callId
string
The ID of the call to send transfer.
Returns
void
Throws
If the callId or digit is not provided.
Throws
If the SDK is not connected before attempting to send DTMF.
Throws
If call to transfer is not found
Implementation of
BicomSDKInterface.completeSupervisedTransfer
connect()
connect(
password,host,deviceUid?):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:420
Establishes a connection to the PBX server using the provided authentication data.
Parameters
email
string
{string} The username for authentication.
password
string
{string} The password for authentication.
host
string
{string} The URL of the PBX server.
deviceUid?
string
Returns
void
Throws
If authentication data is not provided.
Throws
If authentication data has not been set before attempting to connect.
Implementation of
BicomSDKInterface.connect
connectSkipSIP()
connectSkipSIP(
password,host,deviceUid?):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:434
Only establishes a connection to the PBX server using the provided authentication data, and skips connect to sip service.
Parameters
email
string
{string} The username for authentication.
password
string
{string} The password for authentication.
host
string
{string} The URL of the PBX server.
deviceUid?
string
Returns
void
Throws
If authentication data is not provided.
Throws
If authentication data has not been set before attempting to connect.
Implementation of
BicomSDKInterface.connectSkipSIP
deleteVoicemail()
deleteVoicemail(
voicemailFileNames,location):Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:866
Deletes voicemails
Parameters
voicemailFileNames
string[]
voicemail file names to delete
location
location folder
Returns
Promise<void>
Implementation of
BicomSDKInterface.deleteVoicemail
disconnect()
disconnect():
Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:477
Disconnects the SDK from the PBX server.
Returns
Promise<void>
A promise that resolves when the disconnection is complete.
Throws
If already disconnected.
Implementation of
BicomSDKInterface.disconnect
downloadAvatar()
downloadAvatar(
avatarUrl):Promise<string>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1011
Download avatar for given avatar file name. Returns URL of downloaded avatar.
Parameters
avatarUrl
string
Returns
Promise<string>
Implementation of
BicomSDKInterface.downloadAvatar
downloadVoicemail()
downloadVoicemail(
voicemailFileName,location):Promise<VoicemailDownload>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:882
Returns base64 voicemail file content
Parameters
voicemailFileName
string
voicemail file name
location
voicemail location
Returns
Promise<VoicemailDownload>
Implementation of
BicomSDKInterface.downloadVoicemail
fetchCallHistory()
fetchCallHistory(
lastFetchedTimestamp,callHistoryLimit?):Promise<CallHistory>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1093
Fetches call history items.
Parameters
lastFetchedTimestamp
number
timestamp of last fetched call history item. If we provide 0 all call history items will be fetched. It is advised to store call history and avoid providing 0 as timestamp since it will hit service performance.
callHistoryLimit?
number
number of call history items to be fetched. If we don't provide this parameter it will use the default value.
Returns
Promise<CallHistory>
Implementation of
BicomSDKInterface.fetchCallHistory
fetchSmsSessionsWithMessageViaSnapshot()
fetchSmsSessionsWithMessageViaSnapshot():
Promise<SmsSyncConversationsAndMessages>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1191
Syncing messages via file. Using this action when app hasn't been synced for more than 7 days will reduce load on sms service since it will retrieve all sessions and messages via snapshot that is disk cached every 7 days.
Returns
Promise<SmsSyncConversationsAndMessages>
Implementation of
BicomSDKInterface.fetchSmsSessionsWithMessageViaSnapshot
getActiveCalls()
getActiveCalls():
object[]
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:699
Get array of active calls
Returns
object[]
Implementation of
BicomSDKInterface.getActiveCalls
getAdditionalOptions()
getAdditionalOptions():
AdditionalOptions
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:985
Returns additional options
Returns
Implementation of
BicomSDKInterface.getAdditionalOptions
getArchivedUsers()
getArchivedUsers():
User[]
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1007
Returns list of archived users
Returns
User[]
Implementation of
BicomSDKInterface.getArchivedUsers
getAvailablePresenceStatuses()
getAvailablePresenceStatuses():
AvailablePresenceStatus[]
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1058
Returns all available presence statuses
Returns
Implementation of
BicomSDKInterface.getAvailablePresenceStatuses
getBlockCallerId()
getBlockCallerId():
BlockCallerId
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1062
Returns block caller id status for currently logged in user
Returns
Implementation of
BicomSDKInterface.getBlockCallerId
getCallMonitoringPrefixNumber()
getCallMonitoringPrefixNumber():
string
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1081
Returns call monitoring prefix number
Returns
string
Implementation of
BicomSDKInterface.getCallMonitoringPrefixNumber
getConferences()
getConferences():
Conference[]
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:718
Returns list of current dynamic conferences
Returns
Implementation of
BicomSDKInterface.getConferences
getDepartments()
getDepartments():
string[]
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:989
Returns list of departments
Returns
string[]
Implementation of
BicomSDKInterface.getDepartments
getEnabledServices()
getEnabledServices():
string[]
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:706
Returns array of enabled enhanced services
Returns
string[]
Implementation of
BicomSDKInterface.getEnabledServices
getFileSharing()
getFileSharing():
FileSharing
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1179
Returns file sharing instance. Used for uploading and downloading files.
Returns
Implementation of
BicomSDKInterface.getFileSharing
getMobilePhones()
getMobilePhones():
MobilePhone[]
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:916
Returns
Returns list of mobile phones for logged in user
Implementation of
BicomSDKInterface.getMobilePhones
getParkingLot()
getParkingLot(
ext):ParkingLot
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:977
Returns parking lot for given ext
Parameters
ext
string
ext of parking lot
Returns
Implementation of
BicomSDKInterface.getParkingLot
getParkingLots()
getParkingLots():
ParkingLot[]
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:973
Returns list of parking lots
Returns
Implementation of
BicomSDKInterface.getParkingLots
getPwpConfigItem()
getPwpConfigItem(
name):PwpConfigItem
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:969
Returns config item for given config item name
Parameters
name
string
config item name
Returns
Implementation of
BicomSDKInterface.getPwpConfigItem
getPwpConfigItems()
getPwpConfigItems():
PwpConfigItem[]
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:965
Returns list of config items
Returns
Implementation of
BicomSDKInterface.getPwpConfigItems
getSipConfig()
getSipConfig():
SipConfig
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:981
Returns sip config
Returns
Implementation of
BicomSDKInterface.getSipConfig
getStaticConferences()
getStaticConferences():
StaticConferenceInfo[]
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:722
Returns list of static conferences synced last time sdk connected
Returns
Implementation of
BicomSDKInterface.getStaticConferences
getUsers()
getUsers():
User[]
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:993
Returns list of users
Returns
User[]
Implementation of
BicomSDKInterface.getUsers
getUsersWithPresence()
getUsersWithPresence():
UserWithPresence[]
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:997
Returns list of users with presence
Returns
Implementation of
BicomSDKInterface.getUsersWithPresence
hangup()
hangup(
callId):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:656
Hangs up the specified call.
Parameters
callId
string
The ID of the call to hang up.
Returns
void
Implementation of
BicomSDKInterface.hangup
holdCall()
holdCall(
callId):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:554
Parameters
callId
string
Returns
void
initializeSms()
initializeSms(
storedSessions,storedMessages,syncTimestamp):Promise<number>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1187
Initialize sms
Parameters
storedSessions
stored sessinos.
storedMessages
stored messages.
syncTimestamp
number
timestamp when sms was last synced.
Returns
Promise<number>
Implementation of
BicomSDKInterface.initializeSms
isFeatureEnabled()
isFeatureEnabled(
feature):boolean
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:714
Parameters
feature
Returns
boolean
isServiceEnabled()
isServiceEnabled(
service):boolean
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:710
Returns true if given service is enabled, false otherwise
Parameters
service
Returns
boolean
Implementation of
BicomSDKInterface.isServiceEnabled
joinDynamicConference()
joinDynamicConference(
conferenceId,fromNumber,device,numbers):Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:756
Joins dynamic conference
Parameters
conferenceId
string
Conference id to join.
fromNumber
string
Set if starting conference from mobile phone
device
Device from which we want to join the conference
numbers
string[]
List of numbers to invite into the conference
Returns
Promise<void>
Implementation of
BicomSDKInterface.joinDynamicConference
kickParticipantFromConference()
kickParticipantFromConference(
conferenceId,participantUid):Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:771
Kicks participant from conference
Parameters
conferenceId
string
participantUid
string
Returns
Promise<void>
Implementation of
BicomSDKInterface.kickParticipantFromConference
makeCall()
makeCall(
number,audioElement?):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:491
Establishes a call to the specified number using the connected PBX server.
Parameters
number
string
The phone number of the destination party.
audioElement?
HTMLAudioElement
An optional HTMLAudioElement to play during the call. If provided, the SDK will use this element for playback.
Returns
void
Throws
If the SDK is not connected before attempting to make a call.
Implementation of
BicomSDKInterface.makeCall
makeCallWithCallback()
makeCallWithCallback(
fromNumber,destinationNumber):Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:931
Makes a call to destination number using from number as callback number
Parameters
fromNumber
string
number used for callback
destinationNumber
string
number to call
Returns
Promise<void>
Implementation of
BicomSDKInterface.makeCallWithCallback
moveVoicemail()
moveVoicemail(
voicemailFileNames,location,destination):Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:849
Moves voicemails from location folder to destination folder
Parameters
voicemailFileNames
string[]
voiceimail file names to move
location
location folder
destination
destinatino folder
Returns
Promise<void>
Implementation of
BicomSDKInterface.moveVoicemail
muteCall()
muteCall(
callId):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:518
Mutes the specified call.
Parameters
callId
string
The ID of the call to mute.
Returns
void
Throws
If the SDK is not connected before attempting to mute a call.
Throws
If the callId is not provided.
Implementation of
BicomSDKInterface.muteCall
muteConferenceParticipant()
muteConferenceParticipant(
conferenceId,participantUid):Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:790
Mutes particpiant in conference
Parameters
conferenceId
string
participantUid
string
Returns
Promise<void>
Implementation of
BicomSDKInterface.muteConferenceParticipant
parkCall()
parkCall(
callId,parkinglot?,tenantCode?):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:899
Parks call at given parking lot
Parameters
callId
string
callId of a call to park
parkinglot?
string
parking lot number for a call to park. Leave empty to use default parking lot
tenantCode?
string = ...
tenant code of parking lot. Leave empty if system is single tenant
Returns
void
Implementation of
BicomSDKInterface.parkCall
pauseCallRecording()
pauseCallRecording(
callId):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:678
Pauses call recording for call with given callId
Parameters
callId
string
Returns
void
Implementation of
BicomSDKInterface.pauseCallRecording
seenCallHistory()
seenCallHistory():
Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1130
Returns
Promise<void>
sendDTMF()
sendDTMF(
callId,digit):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:590
Sends DTMF (Dual-Tone Multi-Frequency) tones during a call.
Parameters
callId
string
The ID of the call to send DTMF.
digit
string
The DTMF tone to send. Supported tones are '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '*', '#', 'A', 'B', 'C', 'D'.
Returns
void
Throws
If the callId or digit is not provided.
Throws
If the SDK is not connected before attempting to send DTMF.
Throws
If call to send dtmf to is not found
Implementation of
BicomSDKInterface.sendDTMF
setBlockCallerId()
setBlockCallerId(
blockCallerId):Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1066
Sets block caller id state for currently logged in user
Parameters
blockCallerId
block caller id state
Returns
Promise<void>
Implementation of
BicomSDKInterface.setBlockCallerId
setDesktopAwayStatus()
setDesktopAwayStatus(
desktopAway):Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1047
Set desktop away status
Parameters
desktopAway
Returns
Promise<void>
Implementation of
BicomSDKInterface.setDesktopAwayStatus
setMobilePhones()
setMobilePhones(
mobilePhones):Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:920
Sets mobile phones
Parameters
mobilePhones
list of all mobile phones
Returns
Promise<void>
Implementation of
BicomSDKInterface.setMobilePhones
setPhoneDnd()
setPhoneDnd(
phoneDnd):Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:950
Enable/disable phone DND for current logged in user.
Parameters
phoneDnd
Dnd state to switch to for logged in user
Returns
Promise<void>
Implementation of
BicomSDKInterface.setPhoneDnd
smsSession()
smsSession(
number):Promise<DefaultSmsSessionWrapper>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1163
Acquires sms session. If session is already created existing session will be returned, otherwise new session will be created.
Parameters
number
string
destination number.
Returns
Promise<DefaultSmsSessionWrapper>
Implementation of
BicomSDKInterface.smsSession
smsSessions()
smsSessions():
DefaultSmsSessionWrapper[]
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:1147
Returns
DefaultSmsSessionWrapper[]
startCallRecording()
startCallRecording(
callId):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:660
Starts call recording for call with given callId
Parameters
callId
string
Returns
void
Implementation of
BicomSDKInterface.startCallRecording
startDynamicConference()
startDynamicConference(
conferenceNumber,fromNumber,device,numbers):Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:741
Starts dynamic conference
Parameters
conferenceNumber
string
Access number (extension) of the static conference
fromNumber
string
Set if starting conference from mobile phone
device
Device from which we want to join the conference
numbers
string[]
List of numbers to invite into the conference
Returns
Promise<void>
Implementation of
BicomSDKInterface.startDynamicConference
startStaticConference()
startStaticConference(
conferenceNumber,device,numbers):Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:726
Starts static conference
Parameters
conferenceNumber
string
Access number (extension) of the static conference
device
Device from which we want to join the conference
numbers
string[]
List of numbers to invite into the conference
Returns
Promise<void>
Implementation of
BicomSDKInterface.startStaticConference
stopCallRecording()
stopCallRecording(
callId):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:669
Stops call recording for call with given callId
Parameters
callId
string
Returns
void
Implementation of
BicomSDKInterface.stopCallRecording
transferCall()
transferCall(
callId,number):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:602
Transfers call to destination number.
Parameters
callId
string
The ID of the call to send transfer.
number
string
Destination number that call should transfer to.
Returns
void
Throws
If the callId or digit is not provided.
Throws
If the SDK is not connected before attempting to send DTMF.
Throws
If call to transfer is not found
Implementation of
BicomSDKInterface.transferCall
transferCallSupervised()
transferCallSupervised(
callId,number):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:614
Performs supervised call transfer to destination number.
Parameters
callId
string
The ID of the call to send transfer.
number
string
Destination number that call should transfer to.
Returns
void
Throws
If the callId or digit is not provided.
Throws
If the SDK is not connected before attempting to send DTMF.
Throws
If call to transfer is not found
Implementation of
BicomSDKInterface.transferCallSupervised
unholdCall()
unholdCall(
callId):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:572
Parameters
callId
string
Returns
void
unmuteCall()
unmuteCall(
callId):void
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:536
Unmutes the specified call.
Parameters
callId
string
The ID of the call to unmute.
Returns
void
Throws
If the SDK is not connected before attempting to unmute a call.
Throws
If the callId is not provided.
Implementation of
BicomSDKInterface.unmuteCall
unmuteConferenceParticipant()
unmuteConferenceParticipant(
conferenceId,participantUid):Promise<void>
Defined in: sdk/.repo/sdk/src/bicom-sdk.ts:809
Unmutes particpiant in conference
Parameters
conferenceId
string
participantUid
string
Returns
Promise<void>
Implementation of
BicomSDKInterface.unmuteConferenceParticipant