Place an outbound call

Use the SDK to place a test outbound call from a specific agent to a phone number. This is the same endpoint used by the Test Call button in the Paladin UI.

Prerequisites#

• A Paladin API key exported as PALADIN_API_KEY
• A published agent (you need the agent ID)
• A configured telephony provider — see Telephony for Twilio, Vonage, and other setups

Place the call#

from paladin_sdk import PaladinClient
from paladin_sdk._generated_models import InitiateCallRequest

with PaladinClient(api_key="YOUR_API_KEY") as client:
    client.test_phone_call(
        body=InitiateCallRequest(
            workflow_id=123,
            phone_number="+14155551234",
            telephony_configuration_id=42,
            from_phone_number_id=108,
        )
    )

import { PaladinClient } from "@paladin/sdk";

const client = new PaladinClient({ apiKey: "YOUR_API_KEY" });

await client.testPhoneCall({
    body: {
        workflow_id: 123,
        phone_number: "+14155551234",
        telephony_configuration_id: 42,
        from_phone_number_id: 108,
    },
});

Choose the outbound caller number#

telephony_configuration_id selects the telephony configuration, while from_phone_number_id selects one exact active caller ID attached to that configuration. Use the Paladin phone-number record id, not the phone-number text. For SDK test calls, provide both fields when selecting an exact caller ID. If from_phone_number_id is omitted, the provider uses its configured caller-ID selection behavior.

You can retrieve valid ids through the List Phone Numbers endpoint.

Inspect the run#

Every call creates a run you can inspect afterwards. See Calls & runs for what's tracked, or use the Runs API to list and fetch runs programmatically.

Bulk campaigns#

For placing many calls at once (say, from a CSV), use Campaigns rather than looping over test_phone_call — campaigns handle pacing, retries, and progress tracking.