Tool Call

Execute a tool and call someone with the result.

This endpoint is perfect for webhooks - it executes a tool (like WEATHER),
then places an outbound call to speak the result to the recipient.

Examples:

Weather alert call:

POST /tools/WEATHER/call
{
    "tool": "WEATHER",
    "extension": "1001",
    "prefix": "Good morning! Here's your weather update.",
    "suffix": "Have a great day!"
}

Scheduled weather call (from cron/Home Assistant):

curl -X POST http://sip-agent:8080/tools/WEATHER/call \
  -H "Content-Type: application/json" \
  -d '{"tool": "WEATHER", "extension": "5551234567"}'

DateTime announcement:

POST /tools/DATETIME/call
{
    "tool": "DATETIME",
    "params": {"format": "full"},
    "extension": "1001",
    "prefix": "Attention please."
}

With callback for confirmation:

{
    "tool": "WEATHER",
    "extension": "1001",
    "callback_url": "https://example.com/webhook/weather-call-complete"
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Request to execute a tool and call someone with the result.

string
required

Name of the tool to execute (e.g., WEATHER, DATETIME)

params
object

Parameters to pass to the tool

string
required

SIP extension or phone number to call

Message to speak before the tool result

Message to speak after the tool result

integer
Defaults to 30

Seconds to wait for call to be answered

Webhook URL to POST call results to

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json