GET https://services.leadconnectorhq.com/voice-ai/agents
Autorización
Bearer token generado desde el portal Leadway. Ver Autenticación.
Versión de la API.
Query parameters
Page number starting from 1
Number of items per page
Account ID
Query
Respuestas
200 - Agent list retrieved successfully.
200 - Agent list retrieved successfully.
Total number of items
Page number starting from 1
Number of items per page
Show cada item
Show cada item
Unique identifier for the created agent
Unique identifier for the account where this agent operates
Display name of the voice AI agent
Name of the business this agent represents
Greeting message spoken when the agent answers calls
Custom instructions defining the agent’s behavior
Identifier for the speech synthesis voice being used
Language code for the agent’s speech and understanding
Current tolerance level for caller response delays
Maximum call duration in seconds, between 180-900
Indicates whether automatic idle reminders are enabled
Seconds to wait before sending idle reminders, between 1-20
Phone number for receiving inbound calls
Identifier for the number pool managing this agent’s phone allocation
Array of workflow IDs triggered automatically when calls end
Current post-call notification settings including recipient configuration
Time intervals when the agent accepts calls, organized by day of week
Show cada item
Show cada item
Day of the week for this working hours configuration (Monday=1 to Sunday=7) Posibles valores: 1, 2, 3, 4, 5, 6, 7
Array of time intervals when the agent is available on this day
Show cada item
Show cada item
Starting hour of the working interval in 24-hour format (0-23)
Ending hour of the working interval in 24-hour format (0-23)
Starting minute of the working interval (0-59)
Ending minute of the working interval (0-59)
IANA timezone identifier for working hours and scheduling
Indicates whether this agent is excluded from backup scenarios
Current language translation settings including enablement status and target language
Raw actions configured for this agent with complete actionParameters structure
Show cada item
Show cada item
Unique identifier for this action
Type of action Posibles valores: ‘CALL_TRANSFER’, ‘DATA_EXTRACTION’, ‘IN_CALL_DATA_EXTRACTION’, ‘WORKFLOW_TRIGGER’, ‘SMS’, ‘APPOINTMENT_BOOKING’, ‘CUSTOM_ACTION’, ‘KNOWLEDGE_BASE’
Human-readable name for this action
Action parameters - structure varies by actionType
{
"total": 150,
"page": 2,
"pageSize": 10,
"agents": [
{
"id": "507f1f77bcf86cd799439011",
"locationId": "LOC123456789ABCDEF",
"agentName": "Customer Support Agent",
"businessName": "Acme Corporation",
"welcomeMessage": "Hello! Thank you for calling. How can I assist you today?",
"agentPrompt": "You are a helpful customer service representative.",
"voiceId": "507f1f77bcf86cd799439011",
"language": "en-US",
"patienceLevel": "medium",
"maxCallDuration": 600,
"sendUserIdleReminders": true,
"reminderAfterIdleTimeSeconds": 5,
"inboundNumber": "+1234567890",
"numberPoolId": "pool_507f1f77bcf86cd799439011",
"callEndWorkflowIds": [],
"agentWorkingHours": [],
"timezone": "America/New_York",
"isAgentAsBackupDisabled": false,
"actions": [
{
"_id": "507f1f77bcf86cd799439011",
"actionType": "CALL_TRANSFER",
"name": "Transfer to Manager",
"actionParameters": {
"triggerPrompt": "When caller asks for manager",
"triggerMessage": "Let me transfer you",
"transferToType": "number",
"transferToValue": "+1234567890"
}
}
]
}
]
}
400 - Bad Request
400 - Bad Request
{}
401 - Unauthorized
401 - Unauthorized
{}
422 - Unprocessable Entity
422 - Unprocessable Entity
{}
Ejemplo
curl -X GET 'https://services.leadconnectorhq.com/voice-ai/agents' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
const response = await fetch('https://services.leadconnectorhq.com/voice-ai/agents', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/voice-ai/agents',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
<?php
$ch = curl_init('https://services.leadconnectorhq.com/voice-ai/agents');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);