- An external event or an app triggers a call.
- The voice agent conducts the conversation for answered calls.
- The calling app can monitor and act on the call.
- Remind user for an upcoming appointment.
- Verify user-placed orders.
- Send delivery notification or seek confirmation.
- Call as a follow-up of a user’s contact request.
Prerequisites
- An outbound-capable KoreVG voice channel.
- A project-bound Platform API key (
abl_…). Send it in thex-api-keyheader. - The
outbound_calls.initiatescope on the key to place and terminate calls. Theoutbound_calls.readscope to look up, list, summarize, search, and stream calls.
Call lifecycle
A call moves through these phases in order:accepted, dialing, ringing, in_progress, and terminal. A call that connects creates a session. When a call is terminal, its outcome shows how it ended: completed, busy, rejected, no_answer, machine, failed, canceled, or expired.
Placing a call returns at once with the phase accepted. Track the call by looking it up, by listing or searching the call log, or by subscribing to its event stream.
List of endpoints
All paths start with/api/v1/project/{projectSlug}/{env}/outbound-calls.
Behavior to know
- Each request to place a call needs an
idempotencyKey. Repeating the same request returns the original call. Reusing the key with a different body returns409. Use one key per business event, such as one per booking, so a retry doesn’t ring twice. - Pass the values the agent’s
ON_STARTreads insessionMetadata. - Responses always mask the destination number. To find a call by number, use the search endpoint.
- A call that belongs to a different project returns
404, not403.