com.zoiper.zdk.Providers

Class BanafoManager

java.lang.Object

com.zoiper.zdk.Providers.BanafoManager

public class BanafoManager
extends java.lang.Object

Banafo Service Manager

Constructor Summary

Constructors

Constructor and Description
BanafoManager(long handle) Constructor storing the pointer/address to the underlying native object

Method Summary

Modifier and Type	Method and Description
void	addBanafoListener(BanafoEventsHandler value) Adds a new Banafo Service event listener All added listeners will be notified for each event.
Result	cancelAuthorization() Cancels Banafo Service authorization process Cancels the Banafo Service authorization process.
Result	cancelRequest(long requestId) Cancels a Banafo Service request Cancels an already running Banafo service request and discards any results that might be received.
BanafoCall	createCall(java.lang.String banafoId, java.lang.String summary, java.lang.String title, java.lang.String source, OriginType origin, java.lang.String startedAt, java.lang.String acceptedAt, java.lang.String finishedAt, java.lang.String type, java.lang.String localPhone, java.lang.String remotePhone, BanafoContact contact) Creates a BanafoCall object Creates a BanafoCall object
BanafoContact	createContact(java.lang.String banafoId, java.lang.String remoteId, java.lang.String remoteProvider, java.lang.String displayName, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, ContactType type, java.lang.String url, java.lang.String company, java.util.List<java.lang.String> emails, java.util.List<BanafoPhone> phones) Creates a BanafoContact object Creates a BanafoContact object that can be used with setCallContact
BanafoContactSearchCriteria	createContactSearchCriteria(java.lang.String contactId, java.lang.String provider, java.lang.String search, java.util.List<ContactType> types, java.lang.String phone, java.lang.String nationalNumber, boolean reverseLookup, java.lang.String region, int start, int limit, java.lang.String pageId) Creates a BanafoContactSearchCriteria object Creates a BanafoContactSearchCriteria object to be used for listContacts
BanafoRecording	createRecording(java.lang.String banafoId, java.lang.String startedAt, java.lang.String finishedAt, java.lang.String banafoCallId, java.util.List<RecordingStream> streams) Creates a BanafoRecording object Creates a BanafoRecording object
RecordingStream	createRecordingStream(RecordingType origin, java.lang.String type, java.lang.String fileName, java.lang.String languageCode) Creates a RecordingStream object Creates a RecordingStream object
void	dropBanafoListener(BanafoEventsHandler value) Removes a specific already added Banafo Service event listener All added/left listeners will be notified for each event.
protected void	finalize() Ensures the underlying native object destruction
long	forceCreateCallAtServer(BanafoCall call) Force creates Banafo Call at the Banafo Service Manually creates call on the Banafo Server.
long	forceCreateRecordingAtServer(BanafoRecording recording) Force creates Banafo Recording at the Banafo Service Manually creates call recording on the Banafo Server.
long	getProfile() Get Banafo profile Gets Banafo user profile information.
long	handle() Gets the pointer/address to the underlying native object
long	listContacts(BanafoContactSearchCriteria criteria) List contacts based on serch criterias Provides a list of contacts that can come from local or external resources.
long	listIntegrations() List CRM integrations Provides a list of all active integrations for the authenticated user with a provider from the list.
long	listTranscriptLanguages() List Banafo transcript languages Lists Banafo transcript languages.
Result	setCallContact(java.lang.String banafoCallId, BanafoContact contact) Updates contact information to a call Updates contact information to a Banafo call.
Result	setTokens(java.lang.String accessToken, java.lang.String refreshToken) Set Banafo Service authorization tokens Sets the Banafo Service authorization tokens explicitly so there will be no need of authorization process to take place for this service before it is able to be used.
Result	start(java.lang.String schemeAndAuthority, java.lang.String basePath, java.lang.String clientID) Set up and Start the Banafo Service Setup and start the Banafo Service that can be used to query data, upload files, etc to the Banafo Web Service.
Result	startAuthorization() Starts Banafo Service authorization process Starts a Banafo Service authorization sequence.
Result	stop() Stops the Banafo Service Stops the already started Banafo Service along all requests associated with it.
long	uploadRecording(java.lang.String banaforRecordingId, java.lang.String filePathUtf8) Upload audio recording file to the Banafo server Adds a multipart/form-data recording file upload as described by W3C here: https: and RFC 7578.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BanafoManager

public BanafoManager(long handle)

Constructor storing the pointer/address to the underlying native object

Parameters:

handle - Pointer/address to the underlying native object

Method Detail

handle

public long handle()

Gets the pointer/address to the underlying native object

Returns:

Pointer/address to the underlying native object

finalize

protected void finalize()

Ensures the underlying native object destruction

Overrides:

finalize in class java.lang.Object

start

public Result start(java.lang.String schemeAndAuthority,
                    java.lang.String basePath,
                    java.lang.String clientID)

Set up and Start the Banafo Service Setup and start the Banafo Service that can be used to query data, upload files, etc to the Banafo Web Service. Upon starting the Banafo Service it will automatically start getting its well known configuration from the Banafo Web service i.e. change state to 'BanafoServiceStateType::Configuring'.

Parameters:

schemeAndAuthority - The scheme and authority where the Banafo Service is located. This is a required parameter and if empty string is provided the function will fail with 'ResultCode::InvalidArgument'.

basePath - The base path used for the Banafo Service. It doesn't change between requests. This is a required parameter and if empty string is provided the function will fail with 'ResultCode::InvalidArgument'.

clientID - The client ID used by the Banafo Web Service to identify the application. The application must be registered in the Banafo Web service beforehand so that a client ID can be obtained. This is a required parameter and if empty string is provided the function will fail with 'ResultCode::InvalidArgument'.

Returns:

Result of the invocation

See Also:

BanafoServiceStateType stop

stop

public Result stop()

Stops the Banafo Service Stops the already started Banafo Service along all requests associated with it.

Returns:

Result of the invocation

See Also:

start

startAuthorization

public Result startAuthorization()

Starts Banafo Service authorization process Starts a Banafo Service authorization sequence. The authorization is done using OAuth2.0 device flow. To be able to start authorization process the Banafo Service must be in 'BanafoServiceStateType::Ready' state.

Returns:

Result of the invocation

See Also:

BanafoServiceStateType cancelAuthorization

cancelAuthorization

public Result cancelAuthorization()

Cancels Banafo Service authorization process Cancels the Banafo Service authorization process. To be able to cancel the authorization process the Banafo Service must be authorizing i.e. to be in 'BanafoServiceStateType::Ready' or 'BanafoServiceStateType::VerifyingAuthorizing' state.

Returns:

Result of the invocation

See Also:

BanafoServiceStateType cancelAuthorization

setTokens

public Result setTokens(java.lang.String accessToken,
                        java.lang.String refreshToken)

Set Banafo Service authorization tokens Sets the Banafo Service authorization tokens explicitly so there will be no need of authorization process to take place for this service before it is able to be used. To be able to set tokens the Banafo Service must be in 'BanafoServiceStateType::Ready' state.

Parameters:

accessToken - The access token for the service. It can be left empty and a new access token will be obtained from the refresh token.

refreshToken - The refresh token for the service. This is a required parameter and if empty string is provided the function will fail with 'ResultCode::InvalidArgument'.

Returns:

Result of the invocation

See Also:

BanafoServiceStateType startAuthorization

cancelRequest

public Result cancelRequest(long requestId)

Cancels a Banafo Service request Cancels an already running Banafo service request and discards any results that might be received. The request is destroyed.

Parameters:

requestId - The Banafo Service request handler that is going to be canceled. If invalid handler is provided the function will fail with 'ResultCode::NotFound'.

Returns:

Result of the invocation

See Also:

Result

setCallContact

public Result setCallContact(java.lang.String banafoCallId,
                             BanafoContact contact)

Updates contact information to a call Updates contact information to a Banafo call.

Parameters:

banafoCallId - The Banafo call identifier. This is a required parameter and if empty string is provided the function will fail with 'ResultCode::InvalidArgument'.

contact - The new contact data. This is a required parameter and if empty string is provided the function will fail with 'ResultCode::InvalidArgument'.

Returns:

Result of the invocation

See Also:

BanafoContact

listContacts

public long listContacts(BanafoContactSearchCriteria criteria)

List contacts based on serch criterias Provides a list of contacts that can come from local or external resources. In order to get local contacts the 'provider' should be set to "banafo". If no provider specified - contacts from all active external providers will be returned. By default the response will contain the maximum number of contacts as per the provider's limits per request. For basic filtering use the search parameter, for filtering by phone number only using the 'phone' field might generate better results for depending on the providers. In case a Reverse Lookup is desired, the BanafoContactSearchCriteria's 'ReverseLookup' must be set to 'true', 'Region' and 'Phone' MUST be set while all other parameters will be discarded! In case they are empty strings, this function will fail and return 'ZDKInvalidHandle'. Upon success, the banafoEventsHandler::OnContactList will be invoked delivering the contacts.

Parameters:

criteria - The search criteria to be used for the contact listing. This is a required parameter and if empty/NULL is provided the function will and return 'ZDKInvalidHandle'.

Returns:

The Banafo Service request ID corresponding to this list contacts search

See Also:

BanafoEventsHandler cancelRequest

listIntegrations

public long listIntegrations()

List CRM integrations Provides a list of all active integrations for the authenticated user with a provider from the list. Upon success, the 'BanafoEventsHandler::OnIntegrationsList will be invoked delivering the integrations.

Returns:

The Banafo Service request ID corresponding to this list integrations search

See Also:

cancelRequest

uploadRecording

public long uploadRecording(java.lang.String banaforRecordingId,
                            java.lang.String filePathUtf8)

Upload audio recording file to the Banafo server Adds a multipart/form-data recording file upload as described by W3C here: https: and RFC 7578. The advertised file name is retrieved from the passed 'filePathUtf8' by stripping the path itself. The advertised mime type is retrieved from the passed 'filePathUtf8' by extracting the file extension. In case there is no file extension a 'audio/wav' mime is assumed.

Parameters:

banaforRecordingId - The Banafo file identifier received by the 'BanafoEventsHandler::OnEventState' callback once the call recording is started. This is a required parameter and if empty string is provided the function will fail and return 'ZDKInvalidHandle'.

filePathUtf8 - Full pathname of the file to upload. The file must reside on the local system and must be accessible by the library. This is a required parameter and if empty string is provided the function will fail and return 'ZDKInvalidHandle'.

Returns:

The Banafo Service request ID corresponding to this upload request

See Also:

cancelRequest

createContactSearchCriteria

public BanafoContactSearchCriteria createContactSearchCriteria(java.lang.String contactId,
                                                               java.lang.String provider,
                                                               java.lang.String search,
                                                               java.util.List<ContactType> types,
                                                               java.lang.String phone,
                                                               java.lang.String nationalNumber,
                                                               boolean reverseLookup,
                                                               java.lang.String region,
                                                               int start,
                                                               int limit,
                                                               java.lang.String pageId)

Creates a BanafoContactSearchCriteria object Creates a BanafoContactSearchCriteria object to be used for listContacts

Parameters:

contactId - See BanafoContactSearchCriteria

provider - See BanafoContactSearchCriteria

search - See BanafoContactSearchCriteria

types - See BanafoContactSearchCriteria

phone - See BanafoContactSearchCriteria

nationalNumber - See BanafoContactSearchCriteria

reverseLookup - See BanafoContactSearchCriteria

region - See BanafoContactSearchCriteria

start - See BanafoContactSearchCriteria

limit - See BanafoContactSearchCriteria

pageId - See BanafoContactSearchCriteria

Returns:

The newly created BanafoContactSearchCriteria object

See Also:

listContacts

createContact

public BanafoContact createContact(java.lang.String banafoId,
                                   java.lang.String remoteId,
                                   java.lang.String remoteProvider,
                                   java.lang.String displayName,
                                   java.lang.String firstName,
                                   java.lang.String middleName,
                                   java.lang.String lastName,
                                   ContactType type,
                                   java.lang.String url,
                                   java.lang.String company,
                                   java.util.List<java.lang.String> emails,
                                   java.util.List<BanafoPhone> phones)

Creates a BanafoContact object Creates a BanafoContact object that can be used with setCallContact

Parameters:

banafoId - See BanafoContact

remoteId - See BanafoContact

remoteProvider - See BanafoContact

displayName - See BanafoContact

firstName - See BanafoContact

middleName - See BanafoContact

lastName - See BanafoContact

type - See BanafoContact

url - See BanafoContact

company - See BanafoContact

emails - See BanafoContact

phones - See BanafoContact

Returns:

The newly created BanafoContactSearchCriteria object

See Also:

setCallContact

createCall

public BanafoCall createCall(java.lang.String banafoId,
                             java.lang.String summary,
                             java.lang.String title,
                             java.lang.String source,
                             OriginType origin,
                             java.lang.String startedAt,
                             java.lang.String acceptedAt,
                             java.lang.String finishedAt,
                             java.lang.String type,
                             java.lang.String localPhone,
                             java.lang.String remotePhone,
                             BanafoContact contact)

Creates a BanafoCall object Creates a BanafoCall object

Parameters:

banafoId - See BanafoCall

summary - See BanafoCall

title - See BanafoCall

source - See BanafoCall

origin - See BanafoCall

startedAt - See BanafoCall

acceptedAt - See BanafoCall

finishedAt - See BanafoCall

type - See BanafoCall

localPhone - See BanafoCall

remotePhone - See BanafoCall

contact - See BanafoCall

Returns:

The newly created BanafoCall object

See Also:

BanafoCall

createRecordingStream

public RecordingStream createRecordingStream(RecordingType origin,
                                             java.lang.String type,
                                             java.lang.String fileName,
                                             java.lang.String languageCode)

Creates a RecordingStream object Creates a RecordingStream object

Parameters:

origin - See RecordingStream

type - See RecordingStream

fileName - See RecordingStream

languageCode - See RecordingStream

Returns:

The newly created RecordingStream object

See Also:

RecordingStream

createRecording

public BanafoRecording createRecording(java.lang.String banafoId,
                                       java.lang.String startedAt,
                                       java.lang.String finishedAt,
                                       java.lang.String banafoCallId,
                                       java.util.List<RecordingStream> streams)

Creates a BanafoRecording object Creates a BanafoRecording object

Parameters:

banafoId - See BanafoRecording

startedAt - See BanafoRecording

finishedAt - See BanafoRecording

banafoCallId - See BanafoRecording

streams - See BanafoRecording

Returns:

The newly created BanafoRecording object

See Also:

BanafoRecording

forceCreateCallAtServer

public long forceCreateCallAtServer(BanafoCall call)

Force creates Banafo Call at the Banafo Service Manually creates call on the Banafo Server. In case 'BanafoCall::BanafoId' is set, a request to update that already existing call, instead of creating a new one, will be made. Upon completion the 'BanafoEventsHandler::OnEventState' callback will be invoked delivering the result of the request and the 'banafo call id' when creating new calls. The `BanafoCall::Origin`, `BanafoCall::Type`, `BanafoCall::Source` and `BanafoCall::StartedAt` fields are MANDATORY! If any of them is missing, the function will return `ZDKInvalidHandle`! !!! Do not use for calls made through the ZDK as it will duplicate the calls on Banafo !!!

Parameters:

call - The call to be created at the Banafo Service

Returns:

The Banafo Service request ID corresponding to this create request

See Also:

BanafoEventsHandler cancelRequest

forceCreateRecordingAtServer

public long forceCreateRecordingAtServer(BanafoRecording recording)

Force creates Banafo Recording at the Banafo Service Manually creates call recording on the Banafo Server. In case 'BanafoRecording::BanafoId' is set, a request to update that already existing recording, instead of creating a new one, will be made. Upon completion the 'BanafoEventsHandler::OnEventState' callback will be invoked delivering the result of the request and the 'banafo recording id' when creating new recording. That ID can later be used to upload the actual file to the Banafo Server via uploadRecording. The `BanafoRecording::BanafoCallId` field is MANDATORY! If missing, the function will return `ZDKInvalidHandle`! !!! Do not use for recordings made through the ZDK as it will duplicate them on Banafo !!!

Parameters:

recording - The recording to be created at the Banafo Service

Returns:

The Banafo Service request ID corresponding to this create request

See Also:

BanafoEventsHandler cancelRequest uploadRecording

getProfile

public long getProfile()

Get Banafo profile Gets Banafo user profile information. Upon completion the 'BanafoEventsHandler::OnProfile' callback will be invoked delivering the result of the request.

Returns:

The Banafo Service request ID corresponding to this list profile retrieval

See Also:

cancelRequest

listTranscriptLanguages

public long listTranscriptLanguages()

List Banafo transcript languages Lists Banafo transcript languages. Upon completion the 'BanafoEventsHandler::OnTranscriptLanguageList' callback will be invoked delivering the result of the request.

Returns:

The Banafo Service request ID corresponding to this list transcript languages request

See Also:

cancelRequest

addBanafoListener

public void addBanafoListener(BanafoEventsHandler value)

Adds a new Banafo Service event listener All added listeners will be notified for each event.

Parameters:

value - The Banafo Service event listener to be added

See Also:

dropBanafoListener

dropBanafoListener

public void dropBanafoListener(BanafoEventsHandler value)

Removes a specific already added Banafo Service event listener All added/left listeners will be notified for each event.

Parameters:

value - The Banafo Service event listener to be removed

See Also:

addBanafoListener