Jump to Content

Avaya Experience Platform™

Home Developer Guides API Reference Changelog Discussions

Avaya Experience Platform™Log In

API Reference

Home Developer Guides API Reference Changelog Discussions

Licenses

Avaya SDK License Agreement
Avaya Terms of Use for Hosted Services
Acceptable Use Policy

Admin - Account

Account
Audit Records
- Search Audit Recordspost
- Export Audit Recordspost
Organization Structure

Admin - Element Inventory

Audit Records
- Search Audit Recordspost
- Export Audit Recordspost
Element Management
- List Elementsget

Admin - Group

Audit Records
- Search Audit Recordspost
- Export Audit Recordspost
Group Management

Admin - Match

Audit Records
- Search Audit Recordspost
- Export Audit Recordspost
Category
Queue

Admin - Timetable

Audit Records
- Search Audit Recordspost
- Export Audit Recordspost
Holiday
Interval
Timetable

Admin - User

Audit Records
- Search Audit Recordspost
- Export Audit Recordspost
Bulk Job
Bulk User
Profile
Resource Partition
User
User Password Policy
- Get Password Policyget
- Update Password Policyput
UX Profile
- List UX Profilesget
Workspaces
- Get Workspaces detailsget

Admin - Voice

Available Phone Numbers
- List Available Numbersget
Avaya Aura Device Services
Avaya Cloud Office management
Avaya Cloud Office SIP Trunks
- Get ACO SIP Trunkget
Communication Manager
Comm Manager Job Details
Country
- List Available Countriesget
Extension
Hybrid Extension
- Get Extensionsget
- Delete Extensiondelete
Hybrid Skill
Gateway Connection Manager
- Get Gateway Connection Manager server detailsget
Hybrid Cloud Gateway
Hybrid Cloud Manager
- Hybrid Cloud Managerget
Location Profile
Agent Location
Microsoft Teams management
Microsoft Teams SIP Trunks
- Get MS Teams SIP Trunkget
Outbound Number Routing Rules
Phone Number
Reason Codes
SIP Trunks
- Get List Of SIP Trunksget
- Update SIP Trunk Caller IDput
Sync Aura Entities
- Trigger syncpost
System Manager
Voice Numbers And Extensions
- Export Numbersget
Voice Plan

Analytics - Historical Data v1

Dimensions
- List Dimension Namesget
- Get Dimensionget
Reports
- List Report Namesget
- Get Reportget

Analytics - Historical Data v2

Dimensions
- List Dimension Namesget
- Get Dimensionget
Reports
- List Report Namesget
- Get Reportget

Analytics Producer Management

Dictionaries
- Get Dictionariesget
Locales
- List Localesget
Measure Producers
- List Measure Producersget
- Get Measure Producerget

Auth

Access Token
- Generates an access tokenpost

Customer Journey

Engagement
Identifiers
Journey
Participant
- Add Participantpost
- Remove Participantpost
Agent Notes

Digital - Custom Chat

Engagements
Sessions

Digital - Custom Messaging

Asynchronous Messages
- Upload Attachmentspost
- Send Async Messagepost
Provider Dialogs
- Disconnect Dialogpost
Indicators
- Typing Indicatorpost

Digital - Notification

Subscriptions

Digital - SDK Auth

JWT Token
- Generate JWT Tokenpost

Digital - Signed Media

Media
- Upload Mediapost
- Get Mediaget

Digital - Signed Media URI

Signed URI
- Generate Upload URIpost
- Get Download URIget

Draft - Retrieval

Drafts
- List Draftsget
- Get Draftget

Draft - Save

Drafts

Notification

Subscriptions

Routing - Queue Metrics

Queue Metrics
- Request Metricsget

Transcript - Retrieval

Transcript
- List Messagesget

Transcript - Save

Transcript
- Save Transcriptpost

Get Number

get {protocol}://{server}{basePath}/accounts/{accountId}/phone-numbers/{phoneNumberId}

This API requires the Account Administrator role.

Get assigned phone number

Language

Credentials

Log in to use your API keys

URL