Skip to navigation
Get started

Getting started

Place a call and play audio in three steps.
View as Markdown
1

Get your credentials

Ask support to provision an application with your HTTPS webhook URL. You will receive an app_uuid and an api_key: app_uuid identifies your application, and api_key is its secret.

Authenticate API requests with:

Authorization: Bearer app_3f9c0b2a-7d41-4e8b-9f12-2a6c5d0e7b34:<api_key>

The platform signs every webhook delivery. See Webhook signature verification for verification examples.

2

Place a call

Place an outbound call:

curl -X POST https://api.vorbal.dev/v1/sessions:dial \
  -H "Authorization: Bearer app_3f9c0b2a-7d41-4e8b-9f12-2a6c5d0e7b34:<api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+972500000000",
    "from": "+972740000000",
    "ring_timeout_sec": 30,
    "max_duration_sec": 3600
  }'

Save the session_uuid from the response.

3

Play audio

After the session.answered event arrives, play the audio file:

curl -X POST https://api.vorbal.dev/v1/sessions/{session_uuid}/playback/play \
  -H "Authorization: Bearer app_3f9c0b2a-7d41-4e8b-9f12-2a6c5d0e7b34:<api_key>" \
  -H "Content-Type: application/json" \
  -d '{"type":"files","urls":["https://cdn.example.com/greeting.wav"]}'

Playback progress arrives through playback.started and playback.stopped events.

Next steps