Pardon our mess These API docs are a work in progress. Endpoints, examples, and behavior may change as we continue to develop the Partner API v2.

Partner API

Get Voice AI call

GET /api/v2/voice-ai/calls/:call_uuid - Fetch a single Voice AI call.

GET/api/v2/voice-ai/calls/:call_uuid

Fetch a single Voice AI call.

Required scope: voice-ai (or *).

Path parameters

NameRequiredDescription
call_uuidYesCall UUID
 
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/voice-ai/calls/c0a80101-0000-4000-8000-000000000007"
{
  "success": true,
  "call": {
    "call_uuid": "c0a80101-0000-4000-8000-000000000007",
    "status": "completed",
    "contact_uuid": "c0a80101-0000-4000-8000-000000000001"
  }
}

See Errors for the standard error envelope and rate limits.