Conexia Telecom SDK
    Preparing search index...

    Class ConexiaSDK

    Implements

    • ConexiaSDK_2
    Index
    constructor
    emitter profileInfo pwpServiceConnectionState sipServiceConnectionState
    addIntoCall answerCall cancelSupervisedTransfer changePresenceStatus clearCallHistory completeSupervisedTransfer connect connectSkipSIP deleteVoicemail disconnect downloadAvatar downloadVoicemail fetchCallHistory fetchSmsSessionsWithMessageViaSnapshot getActiveCalls getAdditionalOptions getArchivedUsers getAvailablePresenceStatuses getBlockCallerId getCallMonitoringPrefixNumber getConferences getDepartments getEnabledServices getFileSharing getMobilePhones getParkingLot getParkingLots getPwpConfigItem getPwpConfigItems getSipConfig getStaticConferences getUsers getUsersWithPresence hangup holdCall initializeSms isFeatureEnabled isServiceEnabled joinDynamicConference kickParticipantFromConference makeCall makeCallWithCallback moveVoicemail muteCall muteConferenceParticipant parkCall pauseCallRecording seenCallHistory sendDTMF setBlockCallerId setDesktopAwayStatus setMobilePhones setPhoneDnd smsSession smsSessions startCallRecording startDynamicConference startStaticConference stopCallRecording transferCall transferCallSupervised unholdCall unmuteCall unmuteConferenceParticipant
    • get emitter(): EventEmitter

      Returns an event emitter instance for this Conexia SDK, providing access to its connection events and other relevant signals.

      Returns EventEmitter

    • get profileInfo(): ProfileInfo

      Returns profile info created from login response

      Returns ProfileInfo

    • get pwpServiceConnectionState(): PwpServiceConnectionState

      Gets the current sdk service component connection state of the Conexia SDK.

      Returns PwpServiceConnectionState

      The current sdk service component connection state of the Conexia SDK.

    • get sipServiceConnectionState(): SipServiceConnectionState

      Gets the current sip service component connection state of the Conexia SDK.

      Returns SipServiceConnectionState

      The current sip service component connection state of the Conexia SDK.

    • Adds calls and numbers into call

      Parameters

      • callId: string

        desired call callId

      • calls: string[]
      • numbers: string[]

      Returns void

    • Parameters

      • callId: string
      • OptionalaudioElement: HTMLAudioElement

      Returns void

    • Cancels supervised transfer for call

      Parameters

      • callId: string

        The ID of the call to send transfer.

      Returns void

      If the callId or digit is not provided.

      If the SDK is not connected before attempting to send DTMF.

      If call to transfer is not found

    • Change presence status of currently logged in user

      Parameters

      • statusCode: StatusCode

        status code to change status to

      • Optionalexpiration: number

        optional status expiration in minutes (by default status expiration is set to 0 which effectively means indefinitely)

      • OptionalstatusMessage: string

        optional status message

      Returns Promise<void>

    • Clears call history

      Returns Promise<void>

    • Completes supervised transfer for call

      Parameters

      • callId: string

        The ID of the call to send transfer.

      Returns void

      If the callId or digit is not provided.

      If the SDK is not connected before attempting to send DTMF.

      If call to transfer is not found

    • 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.

      • OptionaldeviceUid: string

      Returns void

      If authentication data is not provided.

      If authentication data has not been set before attempting to connect.

    • 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.

      • OptionaldeviceUid: string

      Returns void

      If authentication data is not provided.

      If authentication data has not been set before attempting to connect.

    • Deletes voicemails

      Parameters

      • voicemailFileNames: string[]

        voicemail file names to delete

      • location: VoicemailFolder

        location folder

      Returns Promise<void>

    • Disconnects the SDK from the PBX server.

      Returns Promise<void>

      A promise that resolves when the disconnection is complete.

      If already disconnected.

    • Download avatar for given avatar file name. Returns URL of downloaded avatar.

      Parameters

      • avatarUrl: string

      Returns Promise<string>

    • Returns base64 voicemail file content

      Parameters

      • voicemailFileName: string

        voicemail file name

      • location: VoicemailFolder

        voicemail location

      Returns Promise<VoicemailDownload>

    • 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.

      • OptionalcallHistoryLimit: 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>

    • 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>

    • Get array of active calls

      Returns { key: string; value: SipCallManager }[]

    • Returns list of archived users

      Returns User[]

    • Returns block caller id status for currently logged in user

      Returns BlockCallerId

    • Returns call monitoring prefix number

      Returns string

    • Returns list of current dynamic conferences

      Returns Conference[]

    • Returns list of departments

      Returns string[]

    • Returns array of enabled enhanced services

      Returns string[]

    • Returns file sharing instance. Used for uploading and downloading files.

      Returns FileSharing

    • Returns MobilePhone[]

      Returns list of mobile phones for logged in user

    • Returns parking lot for given ext

      Parameters

      • ext: string

        ext of parking lot

      Returns ParkingLot

    • Returns list of parking lots

      Returns ParkingLot[]

    • Returns config item for given config item name

      Parameters

      • name: string

        config item name

      Returns PwpConfigItem

    • Returns list of config items

      Returns PwpConfigItem[]

    • Returns sip config

      Returns SipConfig

    • Returns list of users

      Returns User[]

    • Hangs up the specified call.

      Parameters

      • callId: string

        The ID of the call to hang up.

      Returns void

    • Parameters

      • callId: string

      Returns void

    • Initialize sms

      Parameters

      • storedSessions: SmsSessionInfo[]

        stored sessinos.

      • storedMessages: SmsMessage[]

        stored messages.

      • syncTimestamp: number

        timestamp when sms was last synced.

      Returns Promise<number>

    • Returns true if given service is enabled, false otherwise

      Parameters

      Returns boolean

    • Joins dynamic conference

      Parameters

      • conferenceId: string

        Conference id to join.

      • fromNumber: string

        Set if starting conference from mobile phone

      • device: Device

        Device from which we want to join the conference

      • numbers: string[]

        List of numbers to invite into the conference

      Returns Promise<void>

    • Kicks participant from conference

      Parameters

      • conferenceId: string
      • participantUid: string

      Returns Promise<void>

    • Establishes a call to the specified number using the connected PBX server.

      Parameters

      • number: string

        The phone number of the destination party.

      • OptionalaudioElement: HTMLAudioElement

        An optional HTMLAudioElement to play during the call. If provided, the SDK will use this element for playback.

      Returns void

      If the SDK is not connected before attempting to make a call.

    • 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>

    • Moves voicemails from location folder to destination folder

      Parameters

      • voicemailFileNames: string[]

        voiceimail file names to move

      • location: VoicemailFolder

        location folder

      • destination: VoicemailFolder

        destinatino folder

      Returns Promise<void>

    • Mutes the specified call.

      Parameters

      • callId: string

        The ID of the call to mute.

      Returns void

      If the SDK is not connected before attempting to mute a call.

      If the callId is not provided.

    • Mutes particpiant in conference

      Parameters

      • conferenceId: string
      • participantUid: string

      Returns Promise<void>

    • Parks call at given parking lot

      Parameters

      • callId: string

        callId of a call to park

      • Optionalparkinglot: string

        parking lot number for a call to park. Leave empty to use default parking lot

      • OptionaltenantCode: string

        tenant code of parking lot. Leave empty if system is single tenant

      Returns void

    • Pauses call recording for call with given callId

      Parameters

      • callId: string

      Returns void

    • Returns Promise<void>

    • 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

      If the callId or digit is not provided.

      If the SDK is not connected before attempting to send DTMF.

      If call to send dtmf to is not found

    • Sets block caller id state for currently logged in user

      Parameters

      Returns Promise<void>

    • Set desktop away status

      Parameters

      Returns Promise<void>

    • Sets mobile phones

      Parameters

      • mobilePhones: MobilePhone[]

        list of all mobile phones

      Returns Promise<void>

    • Enable/disable phone DND for current logged in user.

      Parameters

      • phoneDnd: DndState

        Dnd state to switch to for logged in user

      Returns Promise<void>

    • 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>

    • Returns DefaultSmsSessionWrapper[]

    • Starts call recording for call with given callId

      Parameters

      • callId: string

      Returns void

    • Starts dynamic conference

      Parameters

      • conferenceNumber: string

        Access number (extension) of the static conference

      • fromNumber: string

        Set if starting conference from mobile phone

      • device: Device

        Device from which we want to join the conference

      • numbers: string[]

        List of numbers to invite into the conference

      Returns Promise<void>

    • Starts static conference

      Parameters

      • conferenceNumber: string

        Access number (extension) of the static conference

      • device: Device

        Device from which we want to join the conference

      • numbers: string[]

        List of numbers to invite into the conference

      Returns Promise<void>

    • Stops call recording for call with given callId

      Parameters

      • callId: string

      Returns void

    • 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

      If the callId or digit is not provided.

      If the SDK is not connected before attempting to send DTMF.

      If call to transfer is not found

    • 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

      If the callId or digit is not provided.

      If the SDK is not connected before attempting to send DTMF.

      If call to transfer is not found

    • Parameters

      • callId: string

      Returns void

    • Unmutes the specified call.

      Parameters

      • callId: string

        The ID of the call to unmute.

      Returns void

      If the SDK is not connected before attempting to unmute a call.

      If the callId is not provided.

    • Unmutes particpiant in conference

      Parameters

      • conferenceId: string
      • participantUid: string

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods
    addIntoCallanswerCallcancelSupervisedTransferchangePresenceStatusclearCallHistorycompleteSupervisedTransferconnectconnectSkipSIPdeleteVoicemaildisconnectdownloadAvatardownloadVoicemailfetchCallHistoryfetchSmsSessionsWithMessageViaSnapshotgetActiveCallsgetAdditionalOptionsgetArchivedUsersgetAvailablePresenceStatusesgetBlockCallerIdgetCallMonitoringPrefixNumbergetConferencesgetDepartmentsgetEnabledServicesgetFileSharinggetMobilePhonesgetParkingLotgetParkingLotsgetPwpConfigItemgetPwpConfigItemsgetSipConfiggetStaticConferencesgetUsersgetUsersWithPresencehangupholdCallinitializeSmsisFeatureEnabledisServiceEnabledjoinDynamicConferencekickParticipantFromConferencemakeCallmakeCallWithCallbackmoveVoicemailmuteCallmuteConferenceParticipantparkCallpauseCallRecordingseenCallHistorysendDTMFsetBlockCallerIdsetDesktopAwayStatussetMobilePhonessetPhoneDndsmsSessionsmsSessionsstartCallRecordingstartDynamicConferencestartStaticConferencestopCallRecordingtransferCalltransferCallSupervisedunholdCallunmuteCallunmuteConferenceParticipant