Quickstart
This guide walks you through authenticating, answering an inbound call, and receiving your first webhook event.
Before you begin
Section titled “Before you begin”You need an App ID and API key, issued by an administrator. All requests are scoped to your app, and every session you act on must be owned by your app.
1. Authenticate
Section titled “1. Authenticate”Every request carries two headers:
X-App-ID— your application identifier.X-API-Key— your API key, validated with a constant-time comparison.
See Authentication for the full details.
2. Receive an inbound call
Section titled “2. Receive an inbound call”When a call arrives, the gateway sends a call.new webhook to your registered URL. This is the first event you receive — it is not triggered by any API command.
3. Answer the call
Section titled “3. Answer the call”Send the answer command for the session from the webhook:
curl -X POST https://gateway.example.com/api/v1/sessions/SESSION_UUID/commands/answer \ -H "X-App-ID: my-app" \ -H "X-API-Key: your-api-key" \ -H "Content-Type: application/json" \ -d '{}'The endpoint returns 202 Accepted immediately with a deferred operation envelope. The real result arrives asynchronously as a command.result webhook.
Next steps
Section titled “Next steps”- Browse the Call control endpoints.
- Understand the webhook delivery model.