^
^
JavaScript Customer Interaction Services Package
Table of Contents

< Back to Package Overview

Changelog

Version 3.8.1.0

New Features

Avaya Oceana 3.8.1.0 features that are supported by version 3.8.1.0 of the Customer Interaction Services Client SDK package for Javascript.

  • Approver Flows of Email Approval

Changes from 3.8.0.1 to 3.8.1.0

Version has been updated to 3.8.1.0

WorkProvider

New Methods

workProvider.applyApprovalAttachments(handle, workRequestId, interactionId);

InteractionMessage

New Properties

this.workType

InteractionMediaEmailMessageParser

New Registred Events

AvayaCustomerServices.Providers.UAC.Response.mediaEventTypes.EMAIL_APPROVAL_ATTACHMENTS_ADDED;

uacProvider

New Methods

uacProvider.applyApprovalAttachments(handle, workRequestId, interactionId); uacProvider.rejectEmailMessage(handle, workRequestId, interactionId, payload, rejectCode);

uacProviderConstants

New Constants

APPLY_APPROVAL; REJECTED;

uacResponse

New Media Event Types

EMAIL_APPROVAL_ATTACHMENTS_ADDED;

InteractionMedia API

New Methods

interactionMedia.applyApprovalAttachments();

workService

Change to existing methods

workService.sendEmailMessage(interactionMedia, data);

Interaction API

New Methods

interaction.closeContact();

Version 3.8.0.1

Changes from 3.8.0.0 to 3.8.0.1

Version has been updated to 3.8.0.1

New InteractionMediaMessagesEvent

Properties

this.eventName this.id this.messages

New InteractionMediaMessagesParser

Methods

_.parse

interactionMediaCreatedParser

New Registered Events

AvayaCustomerServices.Providers.UAC.Response.updatedProperties.INTERACTION_MEDIA_MESSAGES

uacMessageTypes

New Event Name

INTERACTION_MEDIA_MESSAGES: 'interaction_media.messages'

uacResponse

New Updated Properties

INTERACTION_MEDIA_MESSAGES: 'INTERACTION_MEDIA_MESSAGES'

InteractionContextMessage

New Properties

this.channelSrc

interactionMessage

Removed Properties

this.createdAt

InteractionMedia

New Callback Methods

interactionMedia.addOnMessagesReceivedCallback(callback);

Version 3.8.0.0

New Features

Avaya Oceana 3.8.0.0 features that are supported by version 3.8.0.0 of the Customer Interaction Services Client SDK package for Javascript.

  • Active event for outbound calls when party answers

Changes from 3.7.0.1 to 3.8.0.0

Version has been updated to 3.8.0.0

cpProvider

New Callback Methods

call.onCallIncomingVideoAddRequestReceived(callback);

AgentProvider

Change to existing methods

agentProvider.login(handle, loginState, workMode, notReadyReason);

interactionMediaRichMediaCreatedEvent

New Properties

this.messages

New InteractionRemoteParticipantAcceptedEvent

Properties

this.id

New InteractionRemoteParticipantAcceptedParser

Registred Events

AvayaCustomerServices.Providers.UAC.Response.mediaEventTypes.ERROR;

interactionUpdateParser

New Registred Events

AvayaCustomerServices.Providers.UAC.Response.interactionUpdatedProperties.INTERACTION; AvayaCustomerServices.Providers.UAC.Response.interactionUpdatedProperties.DESTINATION_PARTICIPANT_ACCEPTED;

New InteractionUpdateStateParser

Properties

this._parsers

Registred Events

AvayaCustomerServices.Providers.UAC.Response.interactionStates.ALERTING; AvayaCustomerServices.Providers.UAC.Response.interactionStates.ACTIVE; AvayaCustomerServices.Providers.UAC.Response.interactionStates.HELD; AvayaCustomerServices.Providers.UAC.Response.interactionStates.ACW; AvayaCustomerServices.Providers.UAC.Response.interactionStates.ACW_PENDING; AvayaCustomerServices.Providers.UAC.Response.interactionStates.PASSIVE; AvayaCustomerServices.Providers.UAC.Response.interactionStates.UNKNOWN;

Methods

interactionUpdateStateParser.parse(); interactionUpdateStateParser.register();

uacMessageTypes

New Event Names

DESTINATION_PARTICIPANT_ACCEPTED;

New Resource Types

PP_OUTBOUND;

uacProvider

New Properties

this._reconnectAttempts

Change to existing methods

uacProvider.login(handle, loginState, workMode, notReadyReason);

uacResponse

New Channel Types

PP_OUTBOUND;

New Media Event Types

ERROR;

New Properties

Response.interactionUpdatedProperties;

agentService

Change to existing methods

agentService.login(loginState, workMode, notReadyReason);

Agent API

Change to existing methods

agent.login(loginState, workMode, notReadyReason);

InteractionMedia API

Change to existing methods

interactionMedia.sendRichMedia(media, richMediaType, additionalRichMediaData);

Interaction API

New Properties

this._onRemoteParticipantAccepted;

New Callback Methods

Interaction.addOnRemoteParticipantAcceptedCallback(callback);

workService

New Interaction Providers Event Names

'interaction.destination_participant_accepted'; 'interaction.answer.requested'; 'interaction.add_video.request';

New Callback Methods

onRemoteParticipantAccepted(interactionCollection, message); onInteractionAnswerRequested(interactionCollection, message); onInteractionIncomingVideoAddRequest(interactionCollection, message);

Change to existing methods

workService.sendRichMediaMessage(interactionMedia, media, richMediaType, additionalRichMediaData);

Version 3.7.0.1

New Features

Avaya Oceana 3.7.0.1 features that are supported by version 3.7.0.1 of the Customer Interaction Services Client SDK package for Javascript.

  • Async messaging channel

Changes from 3.7.0.0 to 3.7.0.1

Version has been updated to 3.7.0.1

InteractionMedia API

New Methods

interactionMedia.sendRichMedia(media, richMediaType, textFallback, sensitivity);

Version 3.7.0.0

New Features

Avaya Oceana 3.7.0.0 features that are supported by version 3.7.0.0 of the Customer Interaction Services Client SDK package for Javascript.

  • Transfer to User

Changes from 3.6.1.0 to 3.7.0.0

Version has been updated to 3.7.0.0

Interaction API

New Methods

interaction.singleStepTransferToUser(userId); interaction.getUsers(searchText);

Version 3.6.1.0

New Features

Avaya Oceana 3.6.1.0 features that are supported by version 3.6.1.0 of the Customer Interaction Services Client SDK package for Javascript.

  • Forward Email

Changes from v.3.6.0 to 3.6.1.0

Version has been updated to 3.6.1.0

InteractionMessage

New Properties

this.intrinsics

InteractionMedia API

New Methods

interactionMedia.applyForwardAttachments();

Version 3.6.0

New Features

Avaya Oceana 3.6.0.0 features that are supported by version 3.6.0.0 of the Customer Interaction Services Client SDK package for Javascript.

  • Enterprise Directory Contacts

Changes from v3.5.0 to v.3.6.0

Version has been updated to 3.6.0

New Contact API

Properties

this.id this.alias this.displayName this.firstName this.lastName this.city this.company this.country this.department this.emailAddresses this.language this.location this.manager this.phoneNumbers this.postalCode this.rank this.state this.streetAddress this.workRoomNumber this.isFavorite

New Contacts API

Properties

this.contactsService this.onContactsAvailable this._onContactsUnavailable this.onContactsSearchResultsUpdated this.onContactsSearchCompleted this._onContactsSearchFailed

Methods

contacts.addOnContactsAvailableCallback(callback); contacts.addOnContactsUnavailableCallback(callback); contacts.addOnContactsSearchResultsUpdatedCallback(callback); contacts.addOnContactsSearchFailedCallback(callback); contacts.addOnContactsSearchCompletedCallback(callback); contacts.isContactsServiceAvailable(); contacts.search(searchString, maxResults); contacts.cancelSearch(); contacts.removeCallbacks();

New ContactsService API

Properties

this._started this._contactsProvider

Methods

contactsService.init(contacts); contactsService.stop(); contactsService.isContactsServiceAvailable(); contactsService.search(searchString, maxResults); contactsService.cancelSearch();

ClientSession API

New Methods

clientSession.createContacts(); clientSession.removeContacts(); clientSession.getContacts();

Interaction API

New Methods

interaction.getCall(); interaction.isIncoming();

Version 3.5.0

Changes from v3.4.0 to v.3.5.0

Version has been updated to 3.5.0

AvayaCustomerServices.Config.NotificationInfo

Change to default properties

this.maxReconnectOnClose = 20; this.timeout = 90000;

New Callback Methods

AvayaCustomerServices.Config.NotificationInfo.onClose(callback);

Client API

client.removeClientSession();

ClientSession API

New Methods

clientSession.addOnClientSessionClosedCallback(callback); clientSession.addOnResourceSessionWorkModeCreatedCallback(callback); clientSession.addOnResourceSessionWorkModeUpdatedCallback(callback); clientSession.addOnResourceSessionWorkModeDeletedCallback(callback); clientSession.addOnDeferredInteractionCallback(callback); clientSession.addOnRemoveDeferredInteractionCallback(callback);

Agent API

New Methods

agent.goAfterContactWork(); agent.addOnStateAfterContactWorkPendingCallback(callback); agent.addOnStateAfterContactWorkCallback(callback); agent.addOnReasonCodesUpdatedCallback(callback);

Change to existing methods

agent.login(loginState, workMode); agent.goReady(workMode);

Work API

New Methods

work.retrieveDeferredInteraction(deferredInteraction); work.removeDeferredInteraction(deferredInteraction);

Interaction API

New Methods

interaction.defer(interval, reason, payload, options); interaction.addOnInteractionACWPendingCallback(callback);

Change to existing methods

interaction.consult(remoteAddress, uui);

Team API

New Methods

team.setTeamMonitoring(role, monitor); team.setTeamMemberMonitoring(role, teamMemberUserHandle, monitor);

TeamMember API

New properties

this.deferredInteractions = [];

Version 3.4.0

New Features

Avaya Oceana 3.4.0 features that are supported by version 3.4.0 of the Customer Interaction Services Client SDK package for Javascript.

  • Video
  • Supervisor broadcast messages
  • Supervisor groups
  • Social Interaction (Source & Public/Private)

Changes from v3.3.0 to v.3.4.0

Version has been updated to 3.4.0. Configuration URLs have been change to match UAC service renaming:

    serverInfo: { apiUrl: 'https://BREEZE-FQDN/services/UnifiedAgentController/UACAPI' },
  notificationInfo: { broadcastUrl: 'https://BREEZE-FQDN/services/Broadcast-UnifiedAgentController/broadcast' },    

The config object needs to be created using the following:

Note AvayaCustomerServices.Config.UACConfiguration block, and fallbackTransport argument.

    var uacConfig = {
        uacConfiguration: new AvayaCustomerServices.Config.UACConfiguration({
            enabled: true,
            clientInfo: { id: CLIENT_ID },
            serverInfo: { apiUrl: API_URL },
            notificationInfo: { broadcastUrl: BROADCAST_URL, fallbackTransport: 'websocket' },
            authenticationInfo: { enabled: true, tokens: ['Authorization'] }
        })
    };

Version 3.3.0

New Features

Avaya Oceana 3.3.0 features that are supported by version 3.3.0 of the Customer Interaction Services Client SDK package for Javascript.

  • Avaya Breeze is now used for Authentication - using OAuth 2.0 Authorization Code Grant.
  • Email Attachment Removal
  • Websockets is now the only supported connection transport.

Changes from v3.2.2 to v.3.3.0

Version has been updated to 3.3.0.

Version 3.2.2

New Features

Avaya Oceana 3.2.2 features that are supported by version 3.2.2 of the Customer Interaction Services Client SDK package for Javascript.

  • Social Interaction type.
  • After Contact Work.
  • Disposition Codes.
  • Supervisor Observe, Coach and Barge In (Chat & SMS).
  • Supervisor remote state change & logout.
  • Transfer to Service.
  • UAC snap-in support for Websockets.

Changes from v3.2.1 to v.3.2.2

Version has been updated to 3.2.2.

Existing Object changes

NotificationInfo
  • Support for Websockets (this is the default setting for version 3.2.2).
    • To set to 'long-polling' use the example below
    clientSession.setConfig({
        uacConfiguration: {
            notificationInfo: {
                transport: 'long-polling'
            }
        }
    });
ClientSession API
  • New Callback Methods
    • clientSession.addOnCloseCallback(callback);
Agent API
  • New Methods
    • agent.getSystemPreferences();
    • agent.setSystemPreference(preference);
    • agent.removeSystemPreference(preferenceId);
    • agent.setSystemPreferenceData(data);
Work API
  • Update Callback signatures
Interaction API
  • New Methods
    • interaction.setDispositionCode(dispositionCode);
    • interaction.singleStepTransferToService(serviceId);
    • interaction.getDispositionCode();
  • Updated Methods
    • interaction.extendACW();
  • New Callback Methods
    • interaction.addOnInteractionACWCallback(callback);
    • interaction.addOnInteractionPassiveCallback(callback);
InteractionMedia API
  • New Callback Methods
    • media.addOnFileTransferredCallback(callback);
    • media.addOnCustomerDownloadInitiatedCallback(callback);
    • media.addOnCustomerDownloadCompleteCallback(callback);
  • Removed Callback Methods
    • media.addOnWorkCodeAddedCallback(callback);
  • Updated Methods
    • media.send(message, sensitivity); //sensitivity added
    • media.sendPagePushUrl(url, sensitivity); //sensitivity added
    • media.reportTyping(sensitivity); //sensitivity added
    • media.sendEmailsubject, message, to, from, cc, bcc); //bcc added
Team API
  • New Methods
    • team.observeMemberInteraction(interaction);
    • team.endObserveMemberInteraction(interaction);
    • team.coach(interaction);
    • team.bargeIn(interaction);
TeamMember API
  • New Property
    • member.capabilities;
  • New Methods
    • member.logout(logoutReason);
    • member.goReady();
    • member.goNotReady(notReadyReason);

Callback Signature changes

Callback Type Old Parameters New Parameters
work.addOnInteractionCreatedCallback Work API workRequest, interaction message
work.addOnInteractionDeletedCallback Work API workRequest, interaction message
interaction.addOnInteractionHeldCallback Interaction API interaction message
interaction.addOnInteractionActiveCallback Interaction API interaction message
interaction.addOnInteractionUpdatedCallback Interaction API interaction message
interaction.addOnInteractionEndedCallback Interaction API workRequest, interaction message
interaction.addOnInteractionContextAddedCallback Interaction API interactionContext, message message
interaction.addOnInteractionContextRemovedCallback Interaction API interactionContext, message message
interaction.addOnInteractionMediaAddedCallback Interaction API interactionMedia, message message
interactionMedia.addMessageReceivedCallback InteractionMedia API interactionMedia, message message
interactionMedia.addOnPagePushUrlCallback InteractionMedia API interactionMedia, message message
interactionMedia.addOnAttachmentAddedCallback InteractionMedia API interactionMedia, message message

See the API Reference for details of the message structure returned for each callback.

Deprecations in 3.2.2

None.

Feedback

Your feedback has been successfully submitted.

There was a problem submitting your feedback. Please contact your product support representative.

Page Feedback