Partner API
Create Voice AI call
POST /api/v2/voice-ai/calls - Queue an outbound Voice AI call (immediate or scheduled). Respects calling windows, wallet balance, and agency from-number requirements.
POST
/api/v2/voice-ai/callsQueue an outbound Voice AI call (immediate or scheduled). Respects calling windows, wallet balance, and agency from-number requirements.
Required scope: voice-ai (or *).
JSON body
| Name | Required | Description |
|---|---|---|
phone | Yes | Destination phone (10-digit US or E.164) |
contact_uuid | No | Existing contact UUID (optional; otherwise matched/created by phone) |
first_name | No | Contact first name |
last_name | No | Contact last name |
contact_name | No | Full name fallback when first/last omitted |
voice_agent_uuid | No | Agent to use; defaults to the agency default agent |
outbound_phone_number_uuid | No | Agency phone number UUID to dial from (required when the agency has active numbers) |
delay_seconds | No | Delay before dial (0–86400). Ignored when scheduled_at is set. |
scheduled_at | No | Wall-clock schedule time in the agency calling timezone (e.g. 2026-07-21T14:30) |
curl -s -X POST -H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"phone": "5551234567",
"contact_uuid": "c0a80101-0000-4000-8000-000000000001",
"first_name": "Jane",
"last_name": "Doe",
"voice_agent_uuid": "c0a80101-0000-4000-8000-000000000008",
"outbound_phone_number_uuid": "c0a80101-0000-4000-8000-000000000009",
"delay_seconds": 0
}' \
"https://benefitpath.com/api/v2/voice-ai/calls"{
"success": true,
"call": {
"call_uuid": "c0a80101-0000-4000-8000-000000000007",
"phone": "+15551234567",
"status": "waiting",
"scheduled_at": null,
"scheduled_delay_seconds": 0,
"voice_agent_uuid": "c0a80101-0000-4000-8000-000000000008",
"contact_uuid": "c0a80101-0000-4000-8000-000000000001"
}
}Calls enter waiting and are dialed by the Voice AI scheduler when the calling window allows. Wallet top-ups remain in the dashboard. See also Outbound dialing compliance.
See Errors for the standard error envelope and rate limits.