Avaya Breeze Platform

Interface Overview

The Avaya Breeze Platform provides easy-to-use APIs and a robust Software Development Kit (SDK) to help developers create winning services without having to acquire specialized communications expertise.

Avaya Breeze Service Types

The following types of service (application) can be developed and deployed on the Avaya Breeze Platform:

  • Call Intercept services - Called Party and Calling Party services
    All incoming and outgoing calls between the PSTN and the enterprise can take full advantage of Call Intercept services that run on the Avaya Breeze Platform. This is true regardless of the type of endpoint (H.323 or SIP) and the type of trunk (ISDN or SIP). Station-to-station calls within the enterprise cannot invoke Call Intercept services even if the endpoints are SIP endpoints. There are two types of Call Intercept service:
    • Based on who is being called, a Called Party service looks at the configuration data for that called party to determine how to handle the call.
    • Based on who is placing a call, a Calling Party service looks at the configuration data for that calling party to determine how to handle the call.
  • Outbound Calling services
    Outbound Calling services can initiate calls to phone numbers for the purpose of playing prerecorded announcements and optionally detecting button presses from the called phone.
  • HTTP-invoked services
    HTTP-invoked services perform some action on receipt of an incoming HTTP request.
  • Collaboration Bus-invoked services
    The Collaboration Bus is a core module within the Avaya Breeze Platform that enables services to send messages to other services for the purpose of leveraging the functionality of the other services. Collaboration Bus-invoked services perform some action when they receive a message from another service on the Collaboration Bus.

Note that a given service can fall into more than one category. The categories are not mutually exclusive.

Avaya Breeze APIs Capabilities

The Avaya Breeze Platform provides the following API methods that enable client services to access the Avaya Breeze capabilities:

  • Call Methods
    The Call Methods enable services to monitor or modify calls on behalf of the calling party (user making an outbound call) or called party (user receiving a call). The Call methods include functions for allowing a call, blocking a call, redirecting a call to a different number, forking a call and changing the presented identity of a user. The Call methods also enable services to place outgoing one-party calls.
  • Media Control Methods
    The Media Control methods enable services to play announcements to one or more parties on a call and to collect button press (DTMF) tones.
  • Send Email Methods
    The Send Email Methods enables services to send e-mails to one or more recipients.
  • Send Text Message (SMS) Methods
    The Send Text Message methods enable services to send text (SMS) messages to one or more recipients.
  • Create Conference Methods
    The Create Conference methods enable services to schedule or cancel video or audio conferences using Avaya IX Room Systems. Additional conference management capabilities are also available.
  • Data Access Methods
    The Data Access methods enable services to access user, cluster, service and global data from the provisioning database as administered on System Manager.
  • Collaboration Bus Methods
    The Collaboration Bus methods enable services to asynchronously communicate using a point-to-point model or a publish-subscribe model.
  • Logging and Alarming Methods
    The Logging and Alarming methods enable services to log events and errors.
  • System Status Methods
    The System Status methods enable services to access information about the Avaya Breeze system status (System Overload Level).
  • Eventing Framework Methods
    The Avaya Breeze eventing framework methods send notifications for server and snap-in generated events. The framework is pre-populated with call events, speech search events and system events. Eventing allows snap-ins to produce and consume events.
  • Service Activity Data Methods (Release 3.0.2 and later)
    The Service Activity Data methods enable snap-ins to manage non-SIP and non-HTTP activities so that servers will not be taken out of service until all such activities cease.

Developer documentation to help you use the APIs is available for download from Releases for the release of the Avaya Breeze Platform you are using.

About the Avaya Breeze SDK

The Avaya Breeze Platform includes a Software Development Kit (SDK) for Java developers to create their own services to run on an Avaya Breeze server. Any Java programmer can build, test and deploy a custom service. No specialized telecommunications expertise is needed.

The SDK provides sample application source code, Java libraries and the javadoc for the Avaya Breeze APIs. The SDK is available for download from from Releases for the release of the Avaya Breeze Platform you are using.

About the Avaya Breeze Authorization Helper SDK

The Avaya Breeze Platform includes a Software Development Kit (SDK) for Java developers to create authentication applications for the Avaya Breeze Authorization Service (AS) Snap-in. Any Java programmer can build, test and deploy an authentication application. No specialized telecommunications expertise is needed.

The SDK provides sample application source code, Java libraries and the javadoc for the Avaya Breeze AS Snap-in. The SDK is available for download from from Releases for the release of the Avaya Breeze Platform you are using.

Loading...