Vapi icon

Vapi

Interact with the Vapi voice AI platform

Actions31

Call → Create

AI-generated

Summary

Create an outbound call or batch of calls on the Vapi voice AI platform, specifying target customer numbers and call parameters.

Inputs

  • Assistant ID — ID of the assistant to use for this outbound call; leave empty if using squad or workflow identifiers or JSON objects instead.
  • Phone Number ID — ID of the Vapi phone number to call from; for transient numbers, use the Raw Body with phoneNumber JSON object.
  • Customer Number — A single customer phone number in E.164 format to call; use Customers JSON for batch calls.
  • Schedule Plan — Optional scheduling plan with earliest time to initiate the call in ISO 8601 date-time format.
  • Additional Fields — A collection of optional structured parameters including transient or override objects for assistant, customer(s), squad, and workflow; optional call name; squad and workflow identifiers; and rawBody JSON for advanced raw data that merges and overrides structured fields.

Output shape

a list of call objects or a single call object representing the created outbound call(s)

If multiple calls are created via Customers JSON, the response returns an array of call objects; otherwise, returns a single call object. Advanced Raw Body JSON fields can override structured parameters for flexibility.

Examples

Example 1: Create a single outbound call with a specified assistant, phone number, and customer number.

Specify 'Assistant ID', 'Phone Number ID', and 'Customer Number'; optionally set 'Schedule Plan' for earliest call time.

Example 2: Create batch calls to multiple customers using a Customers JSON array.

Provide 'Customers (JSON Array)' in Additional Fields and any other call parameters as needed.

Links

Discussion