Interfaces
The Avaya Real-time Speech Snap-in provides a set of RESTful Web services (the REST API) that enable voice call speech search capabilities to be incorporated into client applications. The Real-time Speech SDK includes resources to help developers use the REST API. The SDK is available for download under Releases -> Downloads for the Real-time Speech Snap-in.
End of Sale & Support Notice
Effective July 31st, 2018, Avaya Real Time Speech 3.1 Snap-in – including all earlier releases - are End of Sale and End of Support. This snap-in has reached End of Services Support on October 30, 2018.
For More Information
Real-time Speech REST API
The Real-time Speech REST API can be invoked by client applications that can sent HTTP requests. Client applications can use the API to:
- Create a new speech search query. Queries can be simple phrases or incorporate multiple phrases with time-based and logical conditions. The SDK includes a guide to creating effective speech search queries.
- Store and optionally tag queries.
- Retrieve stored queries.
- Update a specified query and/or its tags.
- Delete a specified query.
- Export queries.
- Subscribe to receive notification of call events, such as call alerting or answered, and of speech search events, such as a match on a speech search query.
- Receive and handle call and speech search events.
- Unsubscribe from call and speech search events.
- Start a speech search on a specified call using specified queries or queries that have been stored with specified tags. The voice stream of either or both call participants can be included in the search.
- Stop a specified speech search.
See the developer documentation in the Real-time Speech SDK for detailed information about the fullset of capabilities supported by the API.
Real-time Speech SDK
The Real-time Speech SDK includes the following resources to help developers build Web applications that incorporate real-time speech search capabilities:
- Sample application: demonstrates the capabilities of the REST API, including Query Management functionality and an Event Manager. Installation and developer guides are provided for the sample application.
- Example REST commands: the commands can be imported to the Postman REST client and run to exercise the capabilities of the Real-time Speech REST API. A user guide is also provided for the example REST commands.
- Developer documentation:
- Developing Applications with the Real Time Speech SDK.
- Developing Applications with the Real Time Speech REST API
- Guidelines for the Creation of Effective Search Queries