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

IP Office Centralized CTI Web Services API


IP Office Centralized CTI Web Services API

The IP Office Centralized CTI Web Services API introduced in IP Office Release 10.1 offers an open platform for use by developers 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 is supported for use in a distributed IP Office environment and is not limited to use on a nodal basis, as is the current TAPI SDK. This new API has a dependency on Avaya one-X Portal, thus users will require access to the one-X Portal application. The existing license for CTI Pro is used to enable the capability on IP Office Release 10.1.

API Functionality

The IP Office Centralized CTI Web Services API enables the following:

Telephony functionality includes:

  • Make/Answer/Disconnect a call.
  • Place a call on hold and retrieve a held call.
  • Transfer a call (supervised, single-step).
  • Initiate a conference/Drop a conference participant/Disconnect a conference.
  • Lock/Unlock Conference.
  • Meet-me Conference.
  • Directed Call Pickup.
  • Call Park and Retrieve.
  • Generate DTMF tones.
  • Mute/Unmute.
  • Call Forward.
  • Do Not Disturb.

Call Recording and VoiceMail functionality includes:

  • Start/Stop Call Recording.
  • Request VoiceMail configuration of a user.
  • Request VoiceMail Service status of a user.
  • Request list of VoiceMail messages.
  • Play/Stop playing/Resume playing of VoiceMail message.
  • Reposition VoiceMail message being played.
  • Delete VoiceMail message.
  • Set VoiceMail message state.
  • Pickup a call that is currently leaving a VoiceMail message.

Instant Messaging (IM) and Presence functionality includes:

  • Send and Receive Instant Messages.
  • Set Presence state of a user.
  • Request Presence states.

Call Logs and Directory functionality includes:

  • Request/Delete Call Logs.
  • Directory Search.
  • Fetch Personal Contacts/Fetch All Contacts for a user.
  • Create/Modify/Delete Personal Contact group.
  • Add/Modify/Delete Personal Contact.
  • Retrieve User Photo.

IP Office Centralized CTI Web Services SDK

The IP Office Centralized CTI Web Services SDK includes sample applications along with usage instructions.

The SDK is available for download from the DevConnect portal, under Releases -> Downloads -> Centralized CTI Web Services for the release of IP Office you are using.

Release News

Latest Release