Skip to main content
Retrieve detailed configuration and settings for a specific voice AI agent 
GET https://services.leadconnectorhq.com/voice-ai/agents/{agentId}

​
Autorización

​
Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticación.
​
Version
string
default:"2021-07-28"
required
Versión de la API.

​
Path parameters

​
agentId
string
default:"507f1f77bcf86cd799439011"
required
Unique agent identifier

​
Query parameters

​
locationId
string
default:"LOC123456789ABCDEF"
required
Account ID

​
Respuestas

​
id
string
default:"507f1f77bcf86cd799439011"
required
Unique identifier for the created agent
​
locationId
string
default:"LOC123456789ABCDEF"
required
Unique identifier for the account where this agent operates
​
agentName
string
default:"Customer Support Agent"
required
Display name of the voice AI agent
​
businessName
string
default:"Acme Corporation"
required
Name of the business this agent represents
​
welcomeMessage
string
required
Greeting message spoken when the agent answers calls
​
agentPrompt
string
required
Custom instructions defining the agent’s behavior
​
voiceId
string
default:"507f1f77bcf86cd799439011"
required
Identifier for the speech synthesis voice being used
​
language
string
default:"en-US"
required
Language code for the agent’s speech and understanding
​
patienceLevel
string
default:"medium"
required
Current tolerance level for caller response delays
​
maxCallDuration
number
default:"600"
required
Maximum call duration in seconds, between 180-900
​
sendUserIdleReminders
boolean
default:"True"
required
Indicates whether automatic idle reminders are enabled
​
reminderAfterIdleTimeSeconds
number
default:"5"
required
Seconds to wait before sending idle reminders, between 1-20
​
inboundNumber
string
default:"+1234567890"
Phone number for receiving inbound calls
​
numberPoolId
string
default:"pool_507f1f77bcf86cd799439011"
Identifier for the number pool managing this agent’s phone allocation
​
callEndWorkflowIds
string[]
Array of workflow IDs triggered automatically when calls end
​
sendPostCallNotificationTo
object
Current post-call notification settings including recipient configuration
​
agentWorkingHours
object[]
Time intervals when the agent accepts calls, organized by day of week
​
timezone
string
default:"America/New_York"
required
IANA timezone identifier for working hours and scheduling
​
isAgentAsBackupDisabled
boolean
default:"False"
required
Indicates whether this agent is excluded from backup scenarios
​
translation
object
Current language translation settings including enablement status and target language
​
actions
object[]
required
Raw actions configured for this agent with complete actionParameters structure
{
  "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"
      }
    }
  ]
}

{}

{}

{}

​
Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/voice-ai/agents/YOUR_agentId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

const response = await fetch('https://services.leadconnectorhq.com/voice-ai/agents/YOUR_agentId', {
  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/YOUR_agentId',
    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/YOUR_agentId');
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);