With the Avaya Breeze® platform Application Programming Interface (API), programmers can develop, test, and deploy snap-ins that use the following methods:
Method
Description
Call Methods
Enable a snap-in to monitor or modify calls on behalf of the calling party or called party. Its functions include:
Allowing a call
Blocking a call
Redirecting a call to a different number
Changing the presented identity of a user
Forking a call
Adding a participant to a call
Dropping a participant from a call
Enabling a snap-in to place a call
Media Control Methods
Enable a snap-in to:
Play an announcement to one or more participants on the call and to collect button press or DTMF tones on the call.
Generate and send DTMF tones to a specified called party through Avaya Aura® Media Server.
Record audio from a party in a call to an HTTP file server or to Media Server Content Store.
With Media Control Methods, developers can specify a recording URI that contains the name and storage location, the DTMF key to end the recording, and the maximum recording duration. This recording can then be used in subsequent play requests.
Send Email Methods
Enable a snap-in to send an email to one or more recipients.
Send Text Message Methods
Enable a snap-in to send a text message to one or more recipients.
Create Conference Methods
Enable a snap-in to schedule or cancel a video or an audio conference using Scopia conferencing or Avaya Equinox® Conferencing.
Data Access Methods
Enable a snap-in to access a user, a service, or global data from the provisioning database as administered on System Manager. Data Access Methods also enable the snap-in to access data from an external database by using Java Persistence API (JPA).
Collaboration Bus Methods
Enable snap-ins to asynchronously communicate by using a point-to-point model or a publish-subscribe model.
Logging and Alarming Methods
Enable a snap-in to log events and errors. The serviceability agent sends the snap-in alarms to System Manager.
System Status Methods
Enable a snap-in to access the system status information of Avaya Breeze® platform.
Eventing Framework Methods
Enable notifications for server and snap-in generated events. The framework is prepopulated with events, such as call events and speech search events. Eventing Framework Methods enable snap-ins to produce and consume events.
You can view the complete event repository from the Element Manager user interface.
Authorization Methods
Enable a snap-in to get access tokens for:
The client.
A user authenticated against LDAP.
Authorization Resource methods enable a snap-in to:
Validate an access token.
Retrieve authorization data contained in an access token.
