Skip to content

Prewarm Voicemails

POST
/dialer/sessions/prewarm-voicemails

CONTACTS NOBODY - but it SPENDS. Synthesises voicemail audio in advance.

Text-to-speech is generated per contact and cached so the audio is ready before a rep clicks Start Dialing. No phone rings and no one hears anything, but it is real generation work per contact, which is why it is tiered billable rather than a plain write.

Returns immediately - the work is fired in the background. Duplicates are no-ops (Redis in-flight lock plus a per-contact cache). Voice caps the batch at 20 and so does this contract.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors DialerPrewarmRequest minus org_id.

SYNTHESISES voicemail audio ahead of time. Contacts nobody, but it is real text-to-speech work per contact, which is why it is not a plain write. Voice caps the batch at 20 and that cap is mirrored here so an oversized batch is a 422 from this API rather than a round-trip.

object
agent_id
Any of:
string
contacts
required
Array<object>
>= 1 items <= 20 items

One person to call. to_phone is a REAL phone number of a REAL human.

An unparseable number is SKIPPED rather than rejecting the batch, so read the response to learn who was actually dialed.

object
all_phones
Any of:
Array<object>
object
key
additional properties
any
company
Any of:
string
contact_id
required
string
default_region
Any of:
string
dynamic_columns
Any of:
object
key
additional properties
any
email
Any of:
string
first_name
Any of:
string
is_redial
Any of:
boolean
last_name
Any of:
string
original_call_id
Any of:
string
phone_index
Any of:
integer
redial_count
Any of:
integer
timezone
string
default: America/New_York
title
Any of:
string
to_phone
required
string

Responses

200

Successful Response

object
data
required

An open envelope for one dialer result.

Open because voice owns the shape of a session, a call stub and a queue stat, and it grows them without a contract bump here. A dropped field would otherwise turn an added upstream field into a removed public one.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string