- Educational Resources
- Development Tools & Configurations
- Compliance Testing
The following IP Office interfaces are supported by DevConnect:
Microsoft Telephony API (TAPI)
IP Office provides Computer Telephony Integration (CTI) capabilities via the Telephony API. TAPI is a Microsoft interface that enables third party solutions deployed on Windows machines to apply first- and third-party control to calls.
The DevLink3 API was introduced in IP Office Release 10.0. DevLink3 supersedes the Delta2 record reporting used by the existing DevLink DLL (see below). DevLink3 provides an enhanced, real-time stream of all call events. The stream can be consumed by client applications and used to track calls throughout their lifecycle.
DevLink provides a real-time event stream that can be consumed by client applications. The event stream incorporates Call records, which include call and party/target information. DevLink is superseded by DevLink3 in IP Office Release 10 and higher, and is not recommended for new development. DevLink remains available in Release 10.0 to give developers time to transition their existing solutions. Avaya cannot guaranteed that future releases of IP Office will continue to support DevLink. Developers are advised to upgrade their integration to DevLink3 as soon as possible.
Centralized CTI Web Services
The IP Office Centralized CTI Web Services API introduced in IP Office Release 10.1 offers an open platform for use in creating applications that employ telephony features and other functionalities provided by IP Office such as Call Log, Directory, Instant Messaging, Presence and Voicemail services. The API has a dependency on Avaya one-X Portal and is supported for use in a distributed IP Office environment.
The Location API was introduced in IP Office Release 10.0. The API enables developers to build custom emergency services solutions that can update the dynamic location of an extension that does not have a fixed location, such as a WiFi Cordless phone. In addition, the API supports On-site Notification functionality, enabling solutions to receive notification of emergency services calls and to get information about each call, including the caller's location, from the associated Emergency Services Call Alarm (see below).
Emergency Services Call Alarm
IP Office Release 9.0 introduced the Emergency Services Call Alarm. Developers of emergency services solutions are strongly advised to get emergency call information from the alarm, rather than use other methods. The Alarm was updated in Release 10 to include additional device type detail and to support longer names. In addition, Release 10 introduced the Location API (see above), which enables solutions to receive Emergency Call Notification events whenever an emergency call is initiated on IP Office, regardless of whether it is successful or not. Each of these events includes the content of the corresponding Emergency Services Call Alarm. A guide to the format of the alarm is available for download under Releases - Downloads - Emergency Services Call Alarm tab for the release of IP Office you are using.
IP Office's integrated SIP Server supports third party SIP endpoints such as deskphones, softphones and conferencing speakerphones.
Used by third party entities that interface with IP Office via a SIP trunk. For more information, see the IP Office Public SIP Trunks Overview and Specification available under Releases for the latest release of IP Office.
Used by third-party H.323 deskphones and other endpoints that can register with Communication Manager.
Used by third party entities that interface with IP Office via an H.323 trunk.
Non-IP Trunks and Stations
Used by TDM type solutions, such as PRI trunks and analog stations, that interface with IP Office.
Avaya Breeze® Client SDK
Avaya Breeze Client SDK Release 4.1 adds initial support for IP Office Platform Release 11.0 / Powered by Avaya Release 3.0 and later. Features supported in Avaya Breeze Client SDK Release 4.1 for IP Office Platform are basic voice and video calling only. Any Avaya Breeze Client SDK Release 4.1 application will look like a 3rd Party IP Endpoint to IP Office Platform and will thus require a license for same; this also means no resiliency. Note that Avaya Breeze Client SDK does not currently support VP8 video codec.
WebRTC SDK API
Introduced in IP Office Release 10.1, the IP Office Management API consists of a set of REST-based services which enables developers to consume IP Office configuration objects and incorporate configuration changes to an expanded set of IP Office entities into applications. Requests and responses utilize XML and JSON formats.
The Configuration Service enables IP Office configuration changes to be incorporated in client solutions via a Web service interface, expressing configuration changes via an XML document. The API is supported for use with IP Office Essential Edition, Preferred Edition, Advanced Edition and Server Edition only. Using the API, developers can build custom, Web-based front-ends for administering users and local groups.
Service Monitoring Web Services API and SDK
The Service Monitoring Web Services introduced in IP Office Release 10.1 is a REST Web Services interface that provides read-only access to IP Office system status data in XML format. The data can be used by developer solutions for applications such as proactive resource monitoring or monitoring of the general health and inventory of a fleet of IP Office systems.
Station Message Details Recording (SMDR)
IP Office provides an interface that enables client solutions to obtain SMDR events. A comma-separated SMDR event record is issued whenever a call is completed. The SMDR interface enables the development of call accounting and call billing applications. The IP Office SMDR can be output directly from the IP Office control unit to a designated IP address and port. SMDR information is included in the IP Office Manager manual for the release you are using.
VoiceMail Pro provides message handling for individuals or groups, audio information to callers and links to business applications through services such as Text-to-speech. VoiceMail Pro includes a full telephony application environment where call flows can be set up and interact in real time with business workflows.
SSL VPN Onboarding and
Onboarding Express APIs and SDKs
The Onboarding APIs and SDKs were introduced in IP Office Release 9.1. They enable Business Partners to use their own Avaya VPN Gateways to perform remote customer support over IP Office SSL VPN technology. The SSL VPN Onboarding APIs facilitate the creation of Onboarding XML files that are installed in IP Office for SSL VPN remote support and monitoring. The SSL VPN Onboarding Express API facilitates offline onboarding of IP Office systems. The SDKs, developer documentation and a KT presentation are available for download under Releases - Downloads - SSL VPN Onboarding APIs tab for the release of IP Office you are using.
Used by third party infrastructure H.323-based solutions that interoperate with IP Office.
Used by third party infrastructure solutions that are IP based in nature, such as SNMP collectors, to interface with IP Office.
IP Office interoperates with third party SIP entities based on the IETF SIP standards.
Used by third party infrastructure VPN solutions, such as VPN appliances, to interoperate with IP Office.
Used by third party Wireless infrastructure solutions that interoperate with IP Office.