Create Dispatch

curl -X POST https://api.vaanivoice.ai/api/trigger-call/ \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-Agent-Id: YOUR_CUSTOM_AGENT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "b5d24304-db83-4072-ac9c-df219cb9a65c",
    "medium": "telephony",
    "contact_number": "+919876543210",
    "name": "Football Fan",
    "dnd_check_skipped": true,
    "modify_agent": {
      "persona": {
        "metadata": {
          "sport": "Football",
          "topic": "FIFA World Cup and Premier League"
        },
        "identity": {
          "greeting_message": {
            "agent_message": "Hello! I'\''m your Football Expert. Let'\''s talk about the beautiful game!",
            "agent_speech_delay": 1,
            "interruptible": true
          },
          "system_prompt": "You are a passionate Football expert and enthusiast. Your role is to have an engaging conversation about football. Discuss FIFA World Cup, Premier League, famous players like Messi, Ronaldo, and Mbappe. Be enthusiastic and share interesting facts about the game."
        }
      },
      "training": {
        "know_how": {
          "guardrails": {
            "custom_rules": [
              {
                "name": "Stay on Football Topic",
                "triggers": ["cricket", "basketball", "other sports"],
                "active": true,
                "handlingType": "response",
                "response": "I'\''m specifically here to talk about football! Let'\''s get back to discussing the beautiful game."
              }
            ]
          }
        }
      }
    }
  }'

curl -X POST https://api.vaanivoice.ai/api/trigger-call/ \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-Agent-Id: YOUR_CUSTOM_AGENT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "764bcf29-a556-4bf3-9b0a-058324f423d5",
    "medium": "telephony",
    "contact_number": "+919876543210",
    "name": "Alice Smith",
    "modify_agent": {
      "persona": {
        "metadata": {
          "patient_name": "Alice Smith",
          "department": "cardiology",
          "appointment_date": "15th June",
          "appointment_time": "10:00 AM"
        },
        "identity": {
          "greeting_message": {
            "agent_message": "Hello Alice, this is a reminder about your cardiology appointment.",
            "agent_speech_delay": 1,
            "interruptible": true
          }
        }
      },
      "experience": {
        "settings": {
          "call_settings": {
            "max_call_duration": 5
          }
        }
      }
    }
  }'

curl -X POST https://api.vaanivoice.ai/api/trigger-call/ \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-Agent-Id: YOUR_CUSTOM_AGENT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "764bcf29-a556-4bf3-9b0a-058324f423d5",
    "medium": "webrtc",
    "primary_language": "en",
    "welcome_message": "Hello! I'\''m your custom assistant.",
    "modify_agent": {
      "persona": {
        "identity": {
          "system_prompt": "You are a custom assistant specialized in product support."
        }
      },
      "experience": {
        "settings": {
          "idle_conversation_settings": {
            "idle_call_hangup_timeout": 60
          }
        }
      }
    }
  }'

curl -X POST https://api.vaanivoice.ai/api/trigger-call/ \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-Agent-Id: YOUR_CUSTOM_AGENT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "764bcf29-a556-4bf3-9b0a-058324f423d5",
    "medium": "telephony",
    "contact_number": "+919876543210",
    "name": "Survey Participant",
    "modify_agent": {
      "persona": {
        "identity": {
          "greeting_message": {
            "agent_message": "Hello! I'\''m calling to conduct a quick satisfaction survey."
          }
        }
      },
      "analysis": {
        "extraction": {
          "data_collection": {
            "enabled": true,
            "data_points": [
              {
                "name": "satisfaction_rating",
                "prompt": "What satisfaction rating did the customer provide (1-5)?",
                "values": ["1", "2", "3", "4", "5"],
                "nullable": false
              },
              {
                "name": "feedback_comments",
                "prompt": "What feedback or comments did the customer share?",
                "values": [],
                "nullable": true
              }
            ]
          }
        }
      }
    }
  }'

curl -X POST https://api.vaanivoice.ai/api/trigger-call/ \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-Agent-Id: YOUR_CUSTOM_AGENT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "535d0c34-8086-419e-b39d-ee549fc28e93",
    "medium": "telephony",
    "contact_number": "+919876543210",
    "name": "John",
    "dnd_check_skipped": true,
    "modify_agent": {
      "persona": {
        "metadata": {
          "customer_name": "John Doe",
          "account_type": "Premium",
          "subscription_end": "Dec 31, 2026"
        },
        "identity": {
          "system_prompt": "You are speaking with {{customer_name}}, who has a {{account_type}} account valid until {{subscription_end}}."
        }
      }
    }
  }'

const ws = new WebSocket(
  response.output?.live_captions_url ?? response.live_captions_url,
);

ws.onmessage = (event) => {
  const message = JSON.parse(event.data);

  switch (message.type) {
    case "connected":
      console.log("Connected to live captions");
      break;
    case "history":
      console.log("History:", message.segments);
      break;
    case "transcript":
      console.log(`${message.segment.speaker}: ${message.segment.text}`);
      break;
    case "call_ended":
      console.log("Call ended");
      ws.close();
      break;
  }
};

{
  "id": "unique-segment-id",
  "call_id": "outbound-1776774443-863aa698",
  "event_type": "transcript",
  "speaker": "agent",
  "text": "Hello, how can I help you today?",
  "timestamp": 1776774443.123,
  "is_final": true,
  "segment_index": 1,
  "was_interrupted": false,
  "confidence": 0.95
}