TriggerCallRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/infivoice/json-schema/infivoice-trigger-call-request-schema.json",
  "title": "TriggerCallRequest",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/infivoice-openapi.json#/components/schemas/TriggerCallRequest",
  "type": "object",
  "required": [
    "agentId",
    "toNumber"
  ],
  "properties": {
    "agentId": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the agent to use for the call"
    },
    "toNumber": {
      "type": "string",
      "description": "Phone number to call (E.164 format recommended)"
    },
    "fromNumber": {
      "type": "string",
      "description": "Caller ID phone number (optional, uses default if not provided)"
    },
    "engine": {
      "type": "string",
      "enum": [
        "elevenlabs",
        "plivo",
        "twilio-openai"
      ],
      "description": "Telephony engine to use"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Custom metadata to attach to the call"
    },
    "scheduledAt": {
      "type": "string",
      "format": "date-time",
      "description": "Schedule call for a future time"
    }
  }
}