Voicemail & Screener Detection
Two per-agent toggles that govern how your agent handles a call that isn’t answered by the person you’re trying to reach. On outbound calls the answering party is often not a live human — it may be a carrier voicemail system, or a screener (an automated “Who’s calling?” gatekeeper, or a person triaging the call before handing off). These settings let the agent recognize each case and respond appropriately instead of talking to a dial tone.voicemail_detection_enabled— recognize when a call reaches voicemail and either leave a set message or hang up.screener_handling_enabled— recognize a screener and navigate it toward the intended human.
How the two toggles relate
Screener handling is a strict extension of voicemail detection, not an independent feature. Enabling it requiresvoicemail_detection_enabled
to be true on the same agent — the underlying detector classifies
every answered outbound call as one of HUMAN, VOICEMAIL, or
SCREENER, and the screener branch only runs when detection is on.
Setting
screener_handling_enabled: true while
voicemail_detection_enabled is false has no runtime effect — the
screener branch stays dormant until voicemail detection is also on.
Both features also depend on platform-level enablement that partners do
not control directly: voicemail detection requires account-level
provider support on a supported outbound carrier, and screener
handling requires platform screener handling to be enabled for your
account. If a toggle appears to have no effect on live calls even with
the agent flags set correctly, contact your partner account manager to
confirm these are switched on.
Voicemail detection
When enabled, the agent detects that an outbound call has reached a carrier voicemail system and reacts based onvoicemail_message:
voicemail_messageset — the agent speaks that message verbatim, then ends the call.voicemail_messageempty ornull— the agent hangs up silently on voicemail, leaving no message.
voicemail_message is capped at 500 characters. Pass null or an
empty string to clear it.
Enabling voicemail detection
Leaving no message
Screener handling
A screener is anything that answers the call but isn’t your intended recipient and expects the caller to identify themselves before connecting — an automated “Who may I ask is calling?” prompt, a receptionist, or a personal-assistant gatekeeper. Withscreener_handling_enabled: true, the agent recognizes this case
(distinct from voicemail) and works to get past the screener toward the
target human rather than delivering its main script to the gatekeeper.
Because this rides on the voicemail detector, enable both toggles
together:
Disabling screener handling
Turn off just the screener branch while keeping voicemail detection on:Setting both at agent creation
Both toggles (andvoicemail_message) can be set when you first create
the agent, not only via update:
Reading the current configuration
Both flags and the message are returned on the agent object fromGET /api/v2/agent/{agent_id} (and in the list response):