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.

Authenticate API requests with:

Authorization: Bearer <app_uuid>:<api_key>

Webhook deliveries are signed. See Webhook Signatures for verification examples.

2

Place a Call

$curl -X POST https://api.telekesher.dev/v1/sessions:dial \
>  -H "Authorization: Bearer <app_uuid>:<api_key>" \
>  -H "Content-Type: application/json" \
>  -d '{
>    "to": "+972527121102",
>    "from": "+972747713001",
>    "ring_timeout_sec": 30,
>    "max_duration_sec": 3600
>  }'

Save the session_uuid from the response and wait for the call.answered webhook.

3

Play Audio

$curl -X POST https://api.telekesher.dev/v1/sessions/{session_uuid}/playback/play \
>  -H "Authorization: Bearer <app_uuid>:<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 webhooks.

Next Steps