Documentation Index
Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
Use this file to discover all available pages before exploring further.
Retrieve detailed configuration and settings for a specific voice AI agent
GET https://services.leadconnectorhq.com/voice-ai/agents/{agentId}
Autorizacion
Bearer token generado desde el portal Leadway. Ver Autenticacion. Version
string
default:"2021-07-28"
required
Version de la API.
Path parameters
agentId
string
default:"507f1f77bcf86cd799439011"
required
Unique agent identifier
Query parameters
locationId
string
default:"LOC123456789ABCDEF"
required
Account ID
Respuestas
200 - Agent details retrieved successfully
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
Greeting message spoken when the agent answers calls
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
Array of workflow IDs triggered automatically when calls end
sendPostCallNotificationTo
Current post-call notification settings including recipient configuration
Time intervals when the agent accepts calls, organized by day of week
dayOfTheWeek
number
default:"1"
required
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
startHour
number
default:"9"
required
Starting hour of the working interval in 24-hour format (0-23)
endHour
number
default:"17"
required
Ending hour of the working interval in 24-hour format (0-23)
startMinute
number
default:"0"
required
Starting minute of the working interval (0-59)
endMinute
number
default:"30"
required
Ending minute of the working interval (0-59)
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
Current language translation settings including enablement status and target language
Raw actions configured for this agent with complete actionParameters structure
id
string
default:"507f1f77bcf86cd799439011"
required
Unique identifier for this action
actionType
string
default:"CALL_TRANSFER"
required
Type of action Posibles valores: ‘CALL_TRANSFER’, ‘DATA_EXTRACTION’, ‘IN_CALL_DATA_EXTRACTION’, ‘WORKFLOW_TRIGGER’, ‘SMS’, ‘APPOINTMENT_BOOKING’, ‘CUSTOM_ACTION’, ‘KNOWLEDGE_BASE’
name
string
default:"Transfer to Manager"
required
Human-readable name for this action
Action parameters - structure varies by actionType
{
"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"
}
}
]
}
422 - Unprocessable Entity
Ejemplo
curl -X GET 'https://services.leadconnectorhq.com/voice-ai/agents/YOUR_agentId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
