Skip to main content
POST
Import Contacts into Call Queue

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

agent_id
string<uuid>
required

Voicebot agent that will place the calls.

agent_number_id
string<uuid>
required

Phone number ID to call from. Aliases: agent_number, phone_id.

contact_ids
any
required

Array of contact UUIDs, or the literal string "all".

first_message
string

Override for the agent's first spoken line.

filters
any

Advanced contact filter (same shape as the contact list filters). Only applied when contact_ids="all".

limit
integer

Max contacts to enqueue when contact_ids="all".

scheduled_at
string<date-time>

ISO-8601 datetime; if omitted the queue is processed as soon as workers pick it up.

respect_calling_hours
boolean
default:false

When true, if the batch is triggered outside standard local calling hours it is queued for the next permitted window instead of dialing immediately. Hours are evaluated in the agent's timezone: Mon-Fri 09:00-20:00, Sat 09:00-17:00, and no calls on Sunday. An explicit scheduled_at always takes precedence.

Response

Import summary.

queued
integer
required
skipped
integer
required
total_matching
integer

Set when contact_ids="all" together with a limit.