Developers/API/Schedule Call

Schedule Call API

Live
v1.0

Schedule voice agent calls programmatically using API keys for authentication. Perfect for webhook integrations, CRM automation, and real-time call scheduling. Use the Calls API to retrieve call information and status.

Quick Reference

Base URL

https://notevibes.com

Authentication

Bearer nvb_your_api_key

Endpoints

POST
/api/voice-agents/schedule-call
GET
/api/voice-agents/calls

Required Permissions

POST
Write access
GET
Read access

POST /api/voice-agents/schedule-call

Schedule a new voice agent call

Request Body

{
  "agentId": "string (required)",
  "contact": {
    "name": "string (required)",
    "phoneNumber": "string (required)",
    "email": "string (optional)",
    "tags": ["string"] (optional),
    "notes": "string (optional)",
    "cohort": "string (optional)",
    "list": "string (optional, defaults to 'API')"
  },
  "scheduledFor": "ISO string (optional, defaults to immediate)",
  "timezone": "string (optional, defaults to 'UTC')",
  "metadata": {
    "key": "value"
  } (optional),
  "retry": {
    "count": 3,
    "enabled": true
  } (optional)
}

Response

Success (200)
{
  "success": true,
  "scheduledCallId": "call_123456",
  "message": "Call scheduled successfully for 2024-01-15T10:00:00.000Z"
}
Error (400/401/403/404/500)
{
  "success": false,
  "error": "Error message"
}

Phone Number Format

Phone numbers are automatically normalized to E.164 format:

(555) 123-4567+15551234567
+1 555 123 4567+15551234567
16463978508+16463978508