Please login or register to access secure site features.

Note: By continuing to use DevConnect Program Services you agree to our latest Registered Member Terms.

Sign in using DevConnect ID

Forgot password?

Trouble logging in?

Submit a ticket for Registration Support.

I have an SSO ID

sign in

Don't have a DevConnect or SSO ID ?

Create a DevConnect account or join the program.

register now

Headset Interface API


The Headset Interface API supports the development of headset applications that integrate with Avaya Communicator for Windows Release 2.1 or later, Avaya one-X® Communicator for Windows and the Avaya Aura® Contact Center Release 6.3 or later Agent Desktop deployed in embedded softphone mode. Headset applications enable operations such as make call, answer call and hold call to be performed using controls on third-party headsets. Headset applications can control any type of headset, including Bluetooth® and USB. The Headset Interface is a COM component that exposes the following API methods to Headset applications:

  • Register: enables a Headset application to register with a softphone client.
  • Unregister
  • BlacklistEvent: enables a Headset application to specify a list of call control-related events of which it does not wish to be notified. Unless blacklisted, the following events are notified by a softphone client: IncomingSessionEvent; IncomingSessionEventEx; SessionCreatedEvent; SessionEndedEvent; SessionCreatedEventEx; SessionUpdatedEvent; EstablishedEvent; HeldEvent; UnheldEvent; MuteStateEvent.
  • MakeCall
  • HangupCall
  • AnswerCall
  • IgnoreCall
  • HoldCall
  • UnholdCall
  • MuteCall
  • UnmuteCall

Important Note: To be able to use third-party headsets with Agent Desktop deployed in embedded softphone mode, the Headset Interface DLL must be registered on the client machine. An MSI file is provided that performs the DLL registration automatically. Download the most recent issue of the MSI from the latest release page for Avaya Aura Contact Center, under the Downloads -> Headset Interface API tab.

For detailed information about the Headset Interface APIs and events, and on handling multiple call scenarios, see: