AI
conversation AI, voice AI, agent studio, knowledge base & phone system APIs
Retrieve a paginated list of agents for given location.
cURL
curl --request GET \ --url https://services.leadconnectorhq.com/voice-ai/agents \ --header 'Authorization: Bearer <token>' \ --header 'Version: <version>'
{ "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, "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" } } ], "inboundNumber": "+1234567890", "numberPoolId": "pool_507f1f77bcf86cd799439011", "callEndWorkflowIds": [], "sendPostCallNotificationTo": { "admins": true, "allUsers": false, "contactAssignedUser": false, "specificUsers": [], "customEmails": [] }, "agentWorkingHours": [], "translation": { "enabled": false, "language": "es" } } ] }
Access Token or Private Integration Token
API Version
2021-04-15
Page number starting from 1
1 <= x <= 5000
1
Number of items per page
1 <= x <= 50
10
Location ID
Query
Agent list retrieved successfully.
Total number of items
150
2
Show child attributes
Was this page helpful?