Agent API

Overview

The Agent API enables comprehensive interaction with agent data, providing full CRUD operations for agent management, permissions, skills, and team assignments. All data is represented as JSON objects with standardized response formats.

Usage

Specify agent operations in your API requests to the Agent API endpoint:

• Base URL: /Advanced Dialer/api/agent
• Required Headers:
  • X-Api-Version: 2.0 (required for all requests)
  • Ocp-Apim-Subscription-Key: YOUR_API_KEY (authentication)

Authentication

All Agent API endpoints require API key authentication via header or query parameter:

Header Authentication (Recommended):

Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY

Query Parameter Authentication:

?subscription-key=YOUR_SUBSCRIPTION_KEY

Troubleshooting

If you have questions or technical issues, please open a ticket using this form.