Agent details retrieved successfully
idstringrequired
Unique identifier for the created agent
Example:507f1f77bcf86cd799439011
locationIdstringrequired
Unique identifier for the location where this agent operates
Example:LOC123456789ABCDEF
agentNamestringrequired
Display name of the voice AI agent
Example:Customer Support Agent
businessNamestringrequired
Name of the business this agent represents
Example:Acme Corporation
welcomeMessagestringrequired
Greeting message spoken when the agent answers calls
Example:Hello! Thank you for calling. How can I assist you today?
agentPromptstringrequired
Custom instructions defining the agent's behavior
Example:You are a helpful customer service representative.
voiceIdstringrequired
Identifier for the speech synthesis voice being used
Example:507f1f77bcf86cd799439011
languagestringrequired
Language code for the agent's speech and understanding
Example:en-US
patienceLevelstringrequired
Current tolerance level for caller response delays
Example:medium
maxCallDurationnumberrequired
Maximum call duration in seconds, between 180-900
Possible values: >= 180 and <= 900
Example:600
sendUserIdleRemindersbooleanrequired
Indicates whether automatic idle reminders are enabled
Example:true
reminderAfterIdleTimeSecondsnumberrequired
Seconds to wait before sending idle reminders, between 1-20
Possible values: >= 1 and <= 20
Example:5
inboundNumberstring
Phone number for receiving inbound calls
Example:+1234567890
numberPoolIdstring
Identifier for the number pool managing this agent's phone allocation
Example:pool_507f1f77bcf86cd799439011
callEndWorkflowIdsstring[]
Array of workflow IDs triggered automatically when calls end
Example:[]
sendPostCallNotificationToobject
Current post-call notification settings including recipient configuration
sendPostCallNotificationTo.adminsboolean
Send notifications to admins
Example:true
sendPostCallNotificationTo.allUsersboolean
Send notifications to all users
Example:false
sendPostCallNotificationTo.contactAssignedUserboolean
Send notifications to contact assigned user
Example:false
sendPostCallNotificationTo.specificUsersstring[]
Specific user IDs to notify
Example:[]
sendPostCallNotificationTo.customEmailsstring[]
Custom email addresses to notify
Example:[]
agentWorkingHoursobject[]
Time intervals when the agent accepts calls, organized by day of week
agentWorkingHours[].dayOfTheWeeknumberrequired
Day of the week for this working hours configuration (Monday=1 to Sunday=7)
Available options1234567
Example:1
agentWorkingHours[].intervalsobject[]required
Array of time intervals when the agent is available on this day
agentWorkingHours[].intervals[].startHournumberrequired
Starting hour of the working interval in 24-hour format (0-23)
Possible values: >= 0 and <= 23
Example:9
agentWorkingHours[].intervals[].endHournumberrequired
Ending hour of the working interval in 24-hour format (0-23)
Possible values: >= 0 and <= 23
Example:17
agentWorkingHours[].intervals[].startMinutenumberrequired
Starting minute of the working interval (0-59)
Possible values: >= 0 and <= 59
Example:0
agentWorkingHours[].intervals[].endMinutenumberrequired
Ending minute of the working interval (0-59)
Possible values: >= 0 and <= 59
Example:30
timezonestringrequired
IANA timezone identifier for working hours and scheduling
Example:America/New_York
isAgentAsBackupDisabledbooleanrequired
Indicates whether this agent is excluded from backup scenarios
Example:false
translationobject
Current language translation settings including enablement status and target language
translation.enabledboolean
Whether translation is enabled
Example:false
translation.languagestring
Translation language code
Example:es
actionsobject[]required
Raw actions configured for this agent with complete actionParameters structure
actions[].idstringrequired
Unique identifier for this action
Example:507f1f77bcf86cd799439011
actions[].actionTypestringrequired
Available optionsCALL_TRANSFERDATA_EXTRACTIONIN_CALL_DATA_EXTRACTIONWORKFLOW_TRIGGERSMSAPPOINTMENT_BOOKINGCUSTOM_ACTIONKNOWLEDGE_BASE
Example:CALL_TRANSFER
actions[].namestringrequired
Human-readable name for this action
Example:Transfer to Manager
actions[].actionParametersobjectrequired
Action parameters - structure varies by actionType
oneOf- CallTransferActionParameters
- DataExtractionActionParameters
- InCallDataExtractionActionParameters
- WorkflowTriggerParameters
- SMSParameters
- AppointmentBookingActionParameters
- CustomActionParameters
- KnowledgeBaseParameters
actions[].actionParameters.triggerPromptstringrequired
When to trigger this action during the call
Example:When the caller asks to speak to a manager
actions[].actionParameters.transferToTypestringrequired
Type of transfer destination (currently only "number" is supported)
Available optionsnumber
Example:number
actions[].actionParameters.transferToValuestringrequired
Phone number to transfer to. Must start with +, include country code, contain only numbers, and be 11-16 characters long (e.g., +12345678901).
Example:+12345678901
actions[].actionParameters.triggerMessagestringrequired
Message to tell the caller before transferring
Example:Let me transfer you to a manager right away
actions[].actionParameters.hearWhisperMessageboolean
Whether to play whisper message to the receiving party
Example:true