Start Agent Call

Starts an agent call.

Agent must be active and use an active LLM, and channel must support agent calls, i.e. support AI agents.

By default, calls respect quiet hours restrictions (weekdays 10 PM - 7 AM, no calls on weekends) and business hours, calculated using the channel's timezone (defaults to "America/Los_Angeles"). When restrictions apply, calls are automatically scheduled for the next available time. Use the bypass_quiet_hours parameter to bypass these restrictions, but be careful as this may result in contacting people at inappropriate times.

Accepts an optional schedule_at parameter to schedule the call instead of placing it immediately, but attention, even when scheduled quiet hours restrictions still apply, unless the bypass_quiet_hours parameter is used. Also, the schedule call might be delayed depending on the organization's ongoing call volume, although it's prioritized over non scheduled calls.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

ID of the agent to be used in the call.

Agent must:

  • Be active.
  • Use an active LLM.
Body Params

Start Agent Call Request

Request schema for starting a voice agent call.

boolean
Defaults to false

Should quiet hours restrictions be bypassed for this call?

  • When set to false (default), calls respect quiet hours restrictions which prevent calls during:

    • Weekdays: 10 PM to 7 AM.
    • Weekends: Calls are completely skipped on weekends (Saturday and Sunday).
    • Business Hours: Outside the channel's configured business hours.
  • When set to true, the call will bypass these restrictions, so it must be used with caution.

When quiet hours restrictions apply, the call is automatically scheduled for the next available time. Quiet hours are calculated based on the channel's timezone and if the channel doesn't have a timezone configured, it defaults to "America/Los_Angeles" timezone.

Custom placeholders data to be passed to the agent in the call.

Each key/value pair corresponds to an user defined placeholder, and each value must be a string or a JSON-encodable value.

string
required

Phone number from the channel to be used in the agent call.

Channel must:

  • Be enabled.
  • Be from type phone.
  • Support agent calls, i.e. support AI agents.
date-time

Scheduling time for the agent call.

When informed, must:

  • Be in the ISO 8601 format, e.g. "2026-04-25T10:00:00Z".
  • Be a valid time strictly in the future.

Attention, even when scheduled, quiet hours restrictions still apply, unless the bypass_quiet_hours parameter is used. Also, the schedule call might be delayed depending on the organization's ongoing call volume, although it's prioritized over non scheduled calls.

string
required

Phone number to be called

Responses

Callback
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json