Calls

Place an outbound call

Queues an outbound call and returns immediately with status dialing. Follow the call through webhooks or GET /v1/calls/{call_id}. Requires telephony to be enabled for your tenant; otherwise the call ends as failed.

post/v1/calls

Request

Base URL
https://voice-api.kata.ai
Auth
API key in header X-Partner-Key
TypeScript
https://skmtc.dev/kata/apis/kata-voice-api/docs/v1/calls/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

phone_numberstring required

Number to call, in international format.

notestring

Free text stored with the call, e.g. your own reference.

sip_call_tostring

Dial target when it differs from phone_number, e.g. an extension behind your PBX.

Example request

{
  "phone_number": "+6281234567890",
  "note": "order 1234"
}

Response

Call queued

call_idstring

statusstring

Example response

{
  "call_id": "call-20261015-021000-1a2b3c4d5e6f7a8b",
  "status": "dialing"
}

Changes

No recorded changes to this operation across all 1 revision of this API.