Avaya APIs and SDKs

IMPORTANT NOTICE: READ THIS CAREFULLY BEFORE ELECTRONICALLY ACCESSING OR USING THIS PROPRIETARY PRODUCT, WHICH IS SUBJECT TO COPYRIGHT!

BY OPENING, INSTALLING, DOWNLOADING, COPYING OR OTHERWISE USING THE AVAYA SOFTWARE DEVELOPMENT KIT (“SDK”) YOU, INDIVIDUALLY, AND/OR THE LEGAL ENTITY FOR WHOM YOU ARE (COLLECTIVELY, AS REFERENCED HEREIN, “YOU”, “YOUR”, OR “LICENSEE”) ARE AGREEING TO THE AVAYA SDK LICENSE AGREEMENT, FOUND AT HTTP://SUPPORT.AVAYA.COM/LICENSEINFO (OR A SUCCESSOR SITE PROPERLY NOTICED) WHICH MAY BE UPDATED FROM TIME TO TIME AND WILL APPLY PROSPECTIVELY (THE “AGREEMENT”) BETWEEN YOU AND AVAYA LLC OR ANY AVAYA AFFILIATE (COLLECTIVELY, “AVAYA”). IF YOU ARE ACCEPTING THE TERMS AND CONDITIONS OF THE AGREEMENT ON BEHALF OF A LEGAL ENTITY, YOU REPRESENT AND WARRANT THAT YOU HAVE FULL LEGAL AUTHORITY TO ACCEPT ON BEHALF OF AND BIND SUCH LEGAL ENTITY TO THIS AGREEMENT. BY OPENING THE MEDIA CONTAINER, BY INSTALLING, DOWNLOADING, COPYING OR OTHERWISE USING THE AVAYA SDK OR AUTHORIZING OTHERS TO DO SO, YOU SIGNIFY THAT YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS AGREEMENT. IF YOU DO NOT HAVE SUCH AUTHORITY OR DO NOT WISH TO BE BOUND BY THE TERMS OF THIS AGREEMENT, DO NOT OPEN, INSTALL, DOWNLOAD, COPY OR OTHERWISE USE THE AVAYA SDKS AND YOU SHALL HAVE NO RIGHT TO USE THE SDK POSTED HEREIN.

• For all Avaya Experience Platform (AXP) API & SDK materials, please see developers.avayacloud.comopens in a new tab.

The Web Telephony Interface API Reference .zip download contains JSON files. https://editor-next.swagger.io/ can be used to view this material.

• Web Telephony REST Services APIopens in a new tab
• Avaya Aura Private Cloud Admin Portal Web Services APIopens in a new tab

Developer Documentation

• READ ME FIRST – Avaya Client SDK Developer Documentation Local Archiveopens in a new tab
• Avaya Client SDK Developer Documentation Local Archiveopens in a new tab

Software Development Kits

• Avaya Client SDK for Android, Release 4.35.0.0opens in a new tab
• Avaya Client SDK for iOS, Release 4.35.0.0opens in a new tab
• Avaya Client SDK for JavaScript, Release 4.35.0.0opens in a new tab
• Avaya Client SDK for macOS, Release 4.35.0.0opens in a new tab
• Avaya Client SDK for Windows, Release 4.35.0.0opens in a new tab

Other Developer Resources

• Avaya Client SDK Release Notes Release 4.35.0.0opens in a new tab

MIB Files

• Avaya Aura AES Release 10.2 Dec 2023 - Standard Management Information Base (MIB) filesopens in a new tab
• Avaya Aura AES Release 10.2 Dec 2023 - Product MIB filesopens in a new tab

DMCC APIs

• Avaya Aura AES Release 10.2 Dec 2023 DMCC Java SDK - (Windows)opens in a new tab
• Avaya Aura AES Release 10.2 Dec 2023 DMCC Java SDK - (Linux)opens in a new tab
• Avaya Aura AES Release 10.2 Dec 2023 DMCC XML SDK (Windows)opens in a new tab
• Avaya Aura AES Release 10.2 Dec 2023 DMCC XML SDK (Linux)opens in a new tab
• Avaya Aura AES Release 10.2 Dec 2023 DMCC .NET SDKopens in a new tab
• Recommended Guidance for Avaya Aura AES DMCC Applications Utilizing Call Mediaopens in a new tab

System Management Service

• Avaya Aura AES Release 10.2 Dec 2023 System Management Service (SMS) SDK (Windows)opens in a new tab
• Avaya Aura AES Release 10.2 Dec 2023 System Management Service (SMS) SDK (Linux)opens in a new tab

Telephony Web Services

• Avaya Aura AES Release 8.1.3 Oct 2020 Web Service - Telephony Services SDK (Windows)opens in a new tab
• Avaya Aura AES Release 8.1.3 Oct. 2020 Web Service - Telephony Services SDK (Linux)opens in a new tab

Web Telephony Interface

The Web Telephony Interface API Reference .zip downloads contains JSON files. https://editor-next.swagger.io/ can be used to view this material.

• Avaya Aura AES Web Telephony Interface Service REST API Reference, Release 10.2, version 1opens in a new tab
• Avaya Aura AES Web Telephony Interface Service WebSocket API Reference, Release 10.2, version 1opens in a new tab

JTAPI

• Avaya Aura AES Release 10.2 Dec 2023 JTAPI SDK and Client (Windows)opens in a new tab
• Avaya Aura AES Release 10.2 Dec 2023 JTAPI SDK and Client (Linux)opens in a new tab

TSAPI

• Avaya Aura AES Release 10.2.0.1 Apr 2024 TSAPI Client Win 32 (Windows)opens in a new tab
• Avaya Aura AES Release 10.2.0.1 Apr 2024TSAPI Client 64 Bit (Windows)opens in a new tab
• Avaya Aura AES Release 10.2 Dec 2023 TSAPI Client 32 Bit (Linux)opens in a new tab
• Avaya Aura AES Release 10.2 Dec 2023 TSAPI Client 64 Bit (Linux)opens in a new tab

CVLAN API

• Avaya Aura AES Release 10.2 Dec 2023 CVLAN Client (Windows)opens in a new tab
• Avaya Aura AES Release 10.2 Dec 2023 CVLAN Client (Linux)opens in a new tab

CDR Interface

• Avaya Aura Session Manager Sample XML and Extended Format CDR Filesopens in a new tab
• Avaya Aura Session Manager Sample Standard Format CDR Filesopens in a new tab

Web Services

• Element Manager Web Service SDK, Release 10.2opens in a new tab

PPM Web Services

• Avaya Aura Session Manager PPM Interface Specification for Release 10.x.x, Version 2.14opens in a new tab
• Avaya Aura Session Manager Personal Profile Manager (PPM) Interface for Release 8.1 - 10.x.xopens in a new tab

Web Services

• Avaya Aura System Manager Release 10.x.x User Management Web Services Sample Client SDKopens in a new tab
• Avaya Aura System Manager Release 10.2 Dec 2023 Routing Web Services SDKopens in a new tab
• Element Manager Web Service SDK, Release 10.2opens in a new tab

Configuration Open API

• Avaya SBC Release 10.2.1.0 API Development Kit and Quick Start Guideopens in a new tab
• Avaya SBC Release 10.2.1.0 API Quick Start Guideopens in a new tab
• Avaya SBC Release 10.2.0.1 API Development Kit and Quick Start Guideopens in a new tab
• Avaya SBC Release 10.2.0.1 API Quick Start Guideopens in a new tab
• Avaya SBC Release 10.2 API Development Kit and Quick Start Guideopens in a new tab
• Avaya SBC Release 10.2 API Quick Start Guideopens in a new tab

Template Wizard

• Avaya SBC Release 10.1.2 Template Wizard and DAT Configuration Guideopens in a new tab
• Avaya SBC Release 10.1.2 DAT Configuration Guideopens in a new tab

Developer Resources

• Avaya Experience Portal Release 8.1.1-8.1.2 Automation Web Services Reference Guide, Issue 1.0opens in a new tab

• Developers interested in obtaining the Avaya Orchestration Designer Release 8.1.2 (8.1.2.1101 build) ISO image should contact Avaya DevConnect for download instructions.

Contact Control Service

• Avaya Aura CC & CCS Release 7.1.2.0.1 Contact Control Service JavaScript SDKopens in a new tab
• Avaya Aura CC & CCS Release 7.1.2.2 Contact Control Service Java SDKopens in a new tab
• Avaya Aura CC & CCS Release 7.1.2.0.1 Contact Control Service JavaScript SDK Release Notes & User Guideopens in a new tab
• Avaya Aura CC & CCS Release 7.1.2 Contact Control Service Java SDK Release Notes & User Guideopens in a new tab

Open Interfaces (SOA Web Services)

• Avaya Aura CC Release 7.0 & 7.1.x CCMS Open Networking Web Services SDKopens in a new tab
• Avaya Aura CC Release 7.0 & 7.1.x CCMS Open Queue Web Services SDKopens in a new tab
• Avaya Aura CC Release 7.0 & 7.1.x CCMA Open Interfaces SDKopens in a new tab
• Avaya Aura CC Release 7.0 & 7.1.x CCMM Agent Web Services SDKopens in a new tab
• Avaya Aura CC Release 7.0 & 7.1.x CCMM Outbound Web Services SDKopens in a new tab
• Avaya Aura CC Release 7.0 & 7.1.x Communication Control Toolkit Open Interfaces REST SDKopens in a new tab
• Avaya Aura CC Release 7.0 & 7.1.x Communication Control Toolkit Open Interfaces SOAP SDKopens in a new tab
• Avaya Aura CC Release 7.0 & 7.1.x Contact Control Toolkit Open Interfaces SDK Release Notesopens in a new tab
• Avaya Aura CC Email Open Interfaces Sample Web Serviceopens in a new tab
• Avaya Aura CC Email Open Interfaces – Developing Compliant Web Servicesopens in a new tab

CCMS Programming APIs

• Avaya Aura CC & CCS Release 7.1.1 Real-time Data SDKopens in a new tab
• Avaya Aura CC & CCS Release 7.1.1 Real-time Data API Programmer's Guideopens in a new tab
• Avaya Aura CC & CCS Release 7.1.1 Real-time Statistics Multicast SDKopens in a new tab
• Avaya Aura CC & CCS Release 7.1.1 Real-time Statistic Multicast Programmer's Guideopens in a new tab
• Avaya Aura CC & CCS Release 7.1.1 Host Data Exchange Interface SDKopens in a new tab
• Avaya Aura CC & CCS Release 7.1.1 Host Data Exchange Programmer's Guideopens in a new tab

Enterprise Web Chat

• Avaya Aura CC Release 7.1.2 Enterprise Web Chat SDKopens in a new tab
• Avaya Aura CC Release 7.1.2 Enterprise Web Chat Programming Reference Guideopens in a new tab

CCT .Net API

• Avaya Aura CC Release 7.0.1 CCT .Net SDKopens in a new tab

Historical Reporting Database

• JDBC, Windows, and UNIX ODBC drivers are available for download from InterSystems Cacheopens in a new tab.

Headset Interface API

• Note: Using third-party headsets with Agent Desktop in embedded softphone mode requires registering the Headset Interface DLL on the client machine.
• Agent Desktop Headset Support MSIopens in a new tab
• Avaya one-X Communicator Headset Integration Guide, Issue 1.1 (December 2010)opens in a new tab

Contact Control Service

• Avaya Aura CC & CCS Release 7.1.2.0.1 Contact Control Service JavaScript SDKopens in a new tab
• Avaya Aura CC & CCS Release 7.1.2.2 Contact Control Service Java SDKopens in a new tab
• Avaya Aura CC & CCS Release 7.1.2.0.1 Contact Control Service JavaScript SDK Release Notes & User Guideopens in a new tab
• Avaya Aura CC & CCS Release 7.1.2 Contact Control Service Java SDK Release Notes & User Guideopens in a new tab

Open Interfaces (SOA Web Services)

• Avaya Aura CC Release 7.0 & 7.1.x CCMS Open Queue Web Services SDKopens in a new tab
• Avaya Aura CC Release 7.0 & 7.1.x CCMM Outbound Web Services SDKopens in a new tab
• Avaya Aura CC Email Open Interfaces Sample Web Serviceopens in a new tab
• Avaya Aura CC Email Open Interfaces – Developing Compliant Web Servicesopens in a new tab

CCMS Programming APIs

• Avaya Aura CC & CCS Release 7.1.1 Real-time Data SDKopens in a new tab
• Avaya Aura CC & CCS Release 7.1.1 Real-time Data API Programmer's Guideopens in a new tab
• Avaya Aura CC & CCS Release 7.1.1 Real-time Statistics Multicast SDKopens in a new tab
• Avaya Aura CC & CCS Release 7.1.1 Real-time Statistic Multicast Programmer's Guideopens in a new tab
• Avaya Aura CC & CCS Release 7.1.1 Host Data Exchange Interface SDKopens in a new tab
• Avaya Aura CC & CCS Release 7.1.1 Host Data Exchange Programmer's Guideopens in a new tab

Enterprise Web Chat

• Avaya Aura CC Release 7.1.2 Enterprise Web Chat SDKopens in a new tab
• Avaya Aura CC Release 7.1.2 Enterprise Web Chat Programming Reference Guideopens in a new tab

CCT .Net API

• Avaya Aura CC Release 7.0.1 CCT .Net SDKopens in a new tab

Database Connectivity Drivers

• JDBC and UNIX ODBC drivers are available for download from InterSystems Cacheopens in a new tab.

Pluggable Data Connector

• Proactive Outreach Manager Release 4.0.2 Pluggable Data Connector Installeropens in a new tab

Agent Desktop APIs

• Proactive Outreach Manager Release 4.0.2 Agent Desktop API for .netopens in a new tab
• Proactive Outreach Manager Release 4.0.2 Agent Desktop API for Javaopens in a new tab

Call Recorder API

• Proactive Outreach Manager Release 4.x Call Recorder API Sample Clientopens in a new tab

Event SDK

• Proactive Outreach Manager Release 4.0.2 Event SDKopens in a new tab

Software Development Kits

• Avaya Breeze SDK, Release 3.9opens in a new tab
• Avaya Breeze SDK, Release 3.8.1opens in a new tab
• Authorization Helper APIs for External Clients, Avaya Breeze Release 3.9opens in a new tab
• Authorization Helper APIs for External Clients, Avaya Breeze Release 3.8.1opens in a new tab

Developer Resources

• Getting Started with the Avaya Breeze SDK, Release 3.9, Issue 1opens in a new tab
• Getting Started with the Avaya Breeze SDK, Release 3.8.1.1, Issue 1opens in a new tab
• Avaya Breeze Snap-in Development Guide, Release 3.9, Issue 1opens in a new tab
• Avaya Breeze Snap-in Development Guide, Release 3.8.1.1, Issue 1opens in a new tab
• Avaya Breeze FAQ and Troubleshooting for Snap-in Developers, Release 3.9, Issueopens in a new tab
• Avaya Breeze FAQ and Troubleshooting for Snap-in Developers, Release 3.8, Issue 1opens in a new tab

CSDK External Application API

• Avaya Client SDK External Application API, v188opens in a new tab

TAPI, DevLink3, & DevLink

• IP Office Platform Devlink3 API Descriptionopens in a new tab
• Avaya IP Office DevLink3 Tutorial Guide, Issue 1opens in a new tab
• Avaya IP Office DevLink3 Tutorial Sample Code, Issue 1opens in a new tab
• TAPI 2 Release 1.0.0.44, TAPI 3 Release 1.0.0.44 and DevLink Release 1.0.0.5 driver installersopens in a new tab

SSL VPN Onboarding APIs

• IP Office Release 9.1 SSL VPN Onboarding SDKopens in a new tab
• IP Office Release 9.1 SSL VPN Onboarding Developer’s Guideopens in a new tab
• IP Office Release 9.1 SSL VPN Onboarding Express SDKopens in a new tab
• IP Office Release 9.1 SSL VPN Onboarding Express Developer’s Guideopens in a new tab

Location API & Emergency Service Call Alarm

• Description of Location API Introduced in Release 10.0, Revision 1opens in a new tab
• IP Office Release 10.0 Location API SDKopens in a new tab
• IP Office Release 10.1 Emergency Services Call Alarm Guideopens in a new tab
• Making Use of the Emergency Services Access Enhancements in IP Office Release 9.0/9.1 White Paperopens in a new tab
• IP Office Emergency Services Call Alarm PCAP Filesopens in a new tab

SNMP

• IP Office Management Information Base (MIB) Files, Release 12.0opens in a new tab

WebRTC SDK API

• IP Office Platform Release 11.1.1 WebRTC SDK - Version 1.21opens in a new tab
• IP Office Platform Description of WebRTC SDK API - Issue 1.21opens in a new tab

Web Services

• IP Office Release 11.0.4 Centralized CTI Web Services SDKopens in a new tab
• IP Office Release 11.0.4 CTI Web Services Programmers' Guide - Issue 1.0.3opens in a new tab
• IP Office Release 10.1 Service Monitoring Web Services SDKopens in a new tab
• IP Office Platform Service Monitoring Web Services API - Issue 1.02opens in a new tab
• IP Office Release 11.1 MTCTI-3 Web Services API SDK Version 1.0opens in a new tab

Management API

• IP Office Release 11.0 Management API Developer Reference Guideopens in a new tab

Developer Resources

• Avaya Analytics Release 4.1.1-4.3 REST & WebSocket Open Interface Sample Clientopens in a new tab
• Avaya Analytics Release 4.2-4.3 REST & WebSocket Open Interface API Guide, Issue 1opens in a new tab

Assisted Chat Client APIs

• Avaya Oceana Release 3.10 Web-based Assisted Chat Reference Clientopens in a new tab
• Avaya Oceana Release 3.10 Digital Transcript Filtering Reference Clientopens in a new tab
• Avaya Oceana Release 3.10 Android Assisted Chat Reference Clientopens in a new tab
• Avaya Oceana Release 3.10 iOS Assisted Chat Reference Clientopens in a new tab

Avaya Digital Connector (Messaging) APIs

• Avaya Oceana Release 3.10 Digital Connector (Messaging) SDK (updated May 2024)opens in a new tab

Generic Channel APIs

• Avaya Oceana Release 3.10 Generic Channel Reference Clientopens in a new tab

Developer Resources

• Avaya Oceana Release 3.10 Email Open Interfaces Sample Clientopens in a new tab
• Avaya Oceana Release 3.10 Email Open Interfaces Developer Guideopens in a new tab
• Avaya Oceana Release 3.10 Customer Management Widgetsopens in a new tab
• Avaya Oceana Release 3.10 Customer Management Widgets Installation Guideopens in a new tab

Sample Customer Journey Workflow

• Avaya Oceana Release 3.10 Sample Workflow Definitions and Prompts for Avaya Engagement Designeropens in a new tab
• Avaya Oceana Release 3.10 Sample Self Service Application for Avaya Experience Portalopens in a new tab
• Avaya Oceana Release 3.10 Sample Self Service Application Source for Avaya Experience Portalopens in a new tab

Postman Collections

• Avaya Oceana Work Assignment Postman Collectionsopens in a new tab

Software Development Kits

• Avaya WebRTC Connect Release 4.0.5 SDK for Androidopens in a new tab
• Avaya WebRTC Connect Release 4.0.6 SDK for Javascriptopens in a new tab
• Avaya WebRTC Connect Release 4.0.5 SDK for iOSopens in a new tab
• Avaya WebRTC Connect Release 4.0.6 Software Development Guideopens in a new tab

• 17 December 2024 – Avaya Session Border Controller 10.2.1.0 API Development Kit and Quick Start Guide added
• 17 June 2024 – Initial SDK set published
• 2 July 2024 – Avaya Client SDK Developer Documentation Local Archive added
• 15 July 2024 – Swagger.io link added to Avaya Aura AES and Avaya Aura Private Cloud; Avaya Enterprise Cloud name change to Avaya Aura Private Cloud
• 16 August 2024 – Avaya Breeze platform SDK and Developer Resources added
• 10 December 2024 – Avaya Client SDK Release 4.35 SDKs and Release Notes added

Need assistance using Avaya API’s? Get expert help from Avaya and other developers through Avaya Support Forum boards.  

From broad product operations to specialized API-level questions, Avaya Support forums cover key Avaya platforms & APIs, including Avaya Aura Application Enablement Services; IP Office; Avaya Aura Contact Center; Orchestration Designer and POM; and Avaya Client SDK.

Note: An Avaya SSO ID is required to post/respond in the Support Forums. Developers should use the Other/No Relationship option when signing up for an Avaya SSO IDopens in a new tab.

Avaya Support Forumsopens in a new tab

Application Notes—keys to success

Accelerate and simplify deployments of compliance-tested solutions. Application notes provider detailed implementation guidance on compatible solutions from our ecosystem of ISVs, IHVs, Systems Integrators and Service Providers. Not only do they outline key functionality validates during joint testing, they provide step-by-step configuration guidelines to help drive faster integration efforts. Search Avaya Support using the Technology Partner company or solution name as a keyword and filtering on Application & Technical Notes as a Content Type.

Search Avaya Supportopens in a new tab

Join our ecosystem—get your solution validated

We’ve partnered with TekVizion, an industry-leader for over 20 years in interoperability and related testing services, to validate a broad range of third-party contact center and UC applications and devices with Avaya solutions. 

From core computer telephony integrations (CTIs) to complex AI-enabled contact center solutions, specialized endpoints to vertical-market solutions, developers can obtain validation with Avaya through TekVizion engagements. 

TekVizion's industry-wide expertise enables comprehensive testing services for complex UC and contact center environments, improving the successful deployment of third-party solutions with Avaya.

Email your validation request