Voice API

Your Eras answer the phone and your website by voice, book, take messages and file every call in the Inbox.

Module code voice · 22 actions · 3 data models · 13 events. A key or token never does more here than the person behind it can; row-level security applies exactly as in the app. Scopes: voice (everything), voice:read (read only) or voice:<capability>.

Resources

Lists take limit (up to 200), cursor, order (e.g. -created_at), fields and q; every other query parameter is a column filter: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

Actions

voice.answer_permission

The customer answered the call permission — Allowed: the call is placed now. Declined: it is cancelled and nothing is charged. Machine-only.

Needs voice:handle · changes data

• Canonical address: POST /api/v1/actions/voice.answer_permission

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.call_missed

What it writes: voice_call (update) — awaiting → queued (allowed) or cancelled (declined, released)

Errors: 401 no or expired credential · 403 the credential does not hold voice:handle · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_awaiting · 429 slow down

voice.await_permission

Wait for the customer’s permission to call — WhatsApp lets a business call only someone who allowed it: the request went out, the call waits for their answer. Machine-only.

Needs voice:handle · changes data

• Canonical address: POST /api/v1/actions/voice.await_permission

Input

Preconditions

The action is refused with 409 and one of these codes:

What it writes: voice_call (update) — queued → awaiting permission

Errors: 401 no or expired credential · 403 the credential does not hold voice:handle · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_queued · 429 slow down

voice.complete_call

File a finished call — Writes the transcript, summary, outcome and length, meters the real minutes on your own voice key and tells workflows. Machine-only.

Needs voice:handle · reaches outside (sends, publishes or charges)

• Canonical address: POST /api/v1/actions/voice.complete_call

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.call_finished, voice.appointment_booked, voice.lead_captured, voice.message_taken, voice.transfer_requested, voice.whatsapp_call_finished

What it writes: voice_call (update) — → completed, with transcript, outcome and cost

Errors: 401 no or expired credential · 403 the credential does not hold voice:handle · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 call_not_found, call_finished · 429 slow down

voice.connect_whatsapp

Answer WhatsApp calls — The Era answers voice calls on your WhatsApp Business number too, and files each one in that customer’s WhatsApp chat.

Needs voice:manage · reaches outside (sends, publishes or charges)

• Canonical address: POST /api/v1/actions/voice.connect_whatsapp

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.agent_changed

What it writes: voice_agent (update) — Points the WhatsApp line at the Era (pending until Meta and the voice provider take it)

curl -X POST https://app.getera.io/api/v1/voice_agents/VOICE_AGENT_ID/actions/connect_whatsapp \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"inboxId":"INBOX_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "voice.agent_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.voiceAgents.connectWhatsapp("VOICE_AGENT_ID", {
  inboxId: "INBOX_ID"
})

era voice_agents connect_whatsapp VOICE_AGENT_ID \
  --inbox-id "INBOX_ID"

{
  "name": "era__voice__connect_whatsapp",
  "arguments": {
    "id": "VOICE_AGENT_ID",
    "inboxId": "INBOX_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold voice:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 voice_not_found, inbox_not_whatsapp, whatsapp_taken · 429 slow down

voice.connect_whatsapp_call

Era picked up a WhatsApp call — The computer answered (or placed) the WhatsApp call and the voice is connected — minutes and money checked first. Machine-only.

Needs voice:handle · reaches outside (sends, publishes or charges)

• Canonical address: POST /api/v1/actions/voice.connect_whatsapp_call

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.call_started

What it writes: voice_call (update) — queued → in progress, with its reservation

Errors: 401 no or expired credential · 403 the credential does not hold voice:handle · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_ringing, wrong_computer, voice_not_found, voice_off, minutes_used_up, no_source, budget_exceeded · 429 slow down

voice.decide_whatsapp_call

Answer a ringing WhatsApp call with Era, or let it ring — While a WhatsApp call rings on your computer: Era answers it, or it keeps ringing for you. A workflow on “WhatsApp call ringing” uses this too.

Needs voice:write · reaches outside (sends, publishes or charges)

• Canonical address: POST /api/v1/actions/voice.decide_whatsapp_call

Input

Preconditions

The action is refused with 409 and one of these codes:

What it writes: voice_call (update) — Writes the decision; a call left to ring is closed without cost

curl -X POST https://app.getera.io/api/v1/voice_calls/VOICE_CALL_ID/actions/decide_whatsapp_call \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"answer":true}'

{
  "ok": true,
  "result": "…",
  "events": []
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.voiceCalls.decideWhatsappCall("VOICE_CALL_ID", {
  answer: true
})

era voice_calls decide_whatsapp_call VOICE_CALL_ID \
  --answer true

{
  "name": "era__voice__decide_whatsapp_call",
  "arguments": {
    "id": "VOICE_CALL_ID",
    "answer": true
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold voice:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_ringing · 429 slow down

voice.enable

Give an Era a voice — An Era answers the phone, the website’s voice button and you in the app — with the voice, greeting, hours and abilities you pick.

Needs voice:manage · changes data

• Canonical address: POST /api/v1/actions/voice.enable

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.agent_changed

What it writes: voice_agent (insert) — Writes the voice, switched off until it is ready

curl -X POST https://app.getera.io/api/v1/voice_agents/actions/enable \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"agentId":"AI_AGENT_ID","inboxId":"INBOX_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "voice.agent_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.voiceAgents.enable({
  agentId: "AI_AGENT_ID",
  inboxId: "INBOX_ID"
})

era voice_agents enable \
  --agent-id "AI_AGENT_ID" \
  --inbox-id "INBOX_ID"

{
  "name": "era__voice__enable",
  "arguments": {
    "agentId": "AI_AGENT_ID",
    "inboxId": "INBOX_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold voice:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 agent_not_found, already_has_voice, inbox_not_voice, inbox_taken, unknown_tool, bad_transfer_number, transfer_needs_number, unknown_language, unknown_knowledge_base, site_not_found · 429 slow down

voice.fail_call

A call did not happen — Busy, no answer or failed: nothing is metered and a missed call can be followed up. Machine-only.

Needs voice:handle · reaches outside (sends, publishes or charges)

• Canonical address: POST /api/v1/actions/voice.fail_call

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.call_missed

What it writes: voice_call (update) — → missed / failed / cancelled, released

Errors: 401 no or expired credential · 403 the credential does not hold voice:handle · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 call_finished, invalid_state · 429 slow down

voice.mark_dialed

A call was placed — The provider is ringing the number. Machine-only.

Needs voice:handle · changes data

• Canonical address: POST /api/v1/actions/voice.mark_dialed

Input

Preconditions

The action is refused with 409 and one of these codes:

What it writes: voice_call (update) — queued → in progress

Errors: 401 no or expired credential · 403 the credential does not hold voice:handle · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_queued · 429 slow down

voice.open_call

A call began — Records a call the moment it starts — the phone, the website button or the app — after checking minutes and the voice key. Machine-only.

Needs voice:handle · reaches outside (sends, publishes or charges)

• Canonical address: POST /api/v1/actions/voice.open_call

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.call_started

What it writes: voice_call (insert) — Opens the call

Errors: 401 no or expired credential · 403 the credential does not hold voice:handle · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 voice_not_found, voice_off, channel_off, unknown_bridge, minutes_used_up, no_source, budget_exceeded · 429 slow down

voice.record_sync

Record the voice provider’s answer — The provider took (or refused) the Era’s voice and number. Machine-only.

Needs voice:handle · changes data

• Canonical address: POST /api/v1/actions/voice.record_sync

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.sync_failed

What it writes: voice_agent (update) — Writes the provider ids and the sync state

Errors: 401 no or expired credential · 403 the credential does not hold voice:handle · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 voice_not_found, invalid_state · 429 slow down

voice.record_turn

Record what Era did on a call — Adds the actions of one reply to the call’s log and keeps its working memory. Machine-only.

Needs voice:handle · changes data

• Canonical address: POST /api/v1/actions/voice.record_turn

Input

Preconditions

The action is refused with 409 and one of these codes:

What it writes: voice_call (update) — Appends actions, replaces memory

Errors: 401 no or expired credential · 403 the credential does not hold voice:handle · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 call_not_open · 429 slow down

voice.record_whatsapp

Record whether WhatsApp calls are on — Meta took the calling settings and the voice provider took the bridged number — or one of them refused. Machine-only.

Needs voice:handle · changes data

• Canonical address: POST /api/v1/actions/voice.record_whatsapp

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.sync_failed

What it writes: voice_agent (update) — Writes the WhatsApp line state and the provider number id

Errors: 401 no or expired credential · 403 the credential does not hold voice:handle · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 voice_not_found, invalid_state · 429 slow down

voice.remove

Take an Era’s voice away — The Era stops answering calls. Its call history stays.

Needs voice:delete · removes or cannot be undone · asks a person to confirm when Era runs it

• Canonical address: POST /api/v1/actions/voice.remove

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.agent_changed

What it writes: voice_agent (delete) — Deletes the voice; calls keep their history

curl -X POST https://app.getera.io/api/v1/voice_agents/VOICE_AGENT_ID/actions/remove \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "voice.agent_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.voiceAgents.remove("VOICE_AGENT_ID")

era voice_agents remove VOICE_AGENT_ID

{
  "name": "era__voice__remove",
  "arguments": {
    "id": "VOICE_AGENT_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold voice:delete · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 voice_not_found · 429 slow down

voice.set_enabled

Switch an Era’s voice on or off — On: it answers calls. Off: calls are not answered by Era; nothing is lost.

Needs voice:manage · changes data

• Canonical address: POST /api/v1/actions/voice.set_enabled

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.agent_changed

What it writes: voice_agent (update) — Flips the switch

curl -X POST https://app.getera.io/api/v1/voice_agents/VOICE_AGENT_ID/actions/set_enabled \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"enabled":true}'

{
  "ok": true,
  "result": "…",
  "events": [
    "voice.agent_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.voiceAgents.setEnabled("VOICE_AGENT_ID", {
  enabled: true
})

era voice_agents set_enabled VOICE_AGENT_ID \
  --enabled true

{
  "name": "era__voice__set_enabled",
  "arguments": {
    "id": "VOICE_AGENT_ID",
    "enabled": true
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold voice:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 voice_not_found, no_voice, inbox_not_voice · 429 slow down

voice.set_outcome

Correct a call’s outcome — When Era read a call wrong — it was really a booking, a lead, a message.

Needs voice:write · changes data

• Canonical address: POST /api/v1/actions/voice.set_outcome

Input

Preconditions

The action is refused with 409 and one of these codes:

What it writes: voice_call (update) — Writes the outcome

curl -X POST https://app.getera.io/api/v1/voice_calls/VOICE_CALL_ID/actions/set_outcome \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"outcome":"booked"}'

{
  "ok": true,
  "result": "…",
  "events": []
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.voiceCalls.setOutcome("VOICE_CALL_ID", {
  outcome: "booked"
})

era voice_calls set_outcome VOICE_CALL_ID \
  --outcome "booked"

{
  "name": "era__voice__set_outcome",
  "arguments": {
    "id": "VOICE_CALL_ID",
    "outcome": "booked"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold voice:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 call_not_finished · 429 slow down

voice.set_whatsapp_line

Answer WhatsApp calls on my computer — Era answers the WhatsApp voice calls on your computer’s WhatsApp — which ones, after how many seconds, and whether it may also call people for you. No phone number needed.

Needs voice:manage · changes data

• Canonical address: POST /api/v1/actions/voice.set_whatsapp_line

Input

Preconditions

The action is refused with 409 and one of these codes:

What it writes: voice_whatsapp_line (upsert) — Writes the workspace’s one WhatsApp-on-the-computer line

curl -X POST https://app.getera.io/api/v1/voice_whatsapp_lines/actions/set_whatsapp_line \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"voiceAgentId":"VOICE_AGENT_ID"}'

{
  "ok": true,
  "result": "…",
  "events": []
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.voiceWhatsappLines.setWhatsappLine({
  voiceAgentId: "VOICE_AGENT_ID"
})

era voice_whatsapp_lines set_whatsapp_line \
  --voice-agent-id "VOICE_AGENT_ID"

{
  "name": "era__voice__set_whatsapp_line",
  "arguments": {
    "voiceAgentId": "VOICE_AGENT_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold voice:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 voice_not_found · 429 slow down

voice.start_call

Have Era call someone — Era rings a customer now from your number — to confirm a booking, follow up a lead, say an order is ready. Minutes are checked first.

Needs voice:write · reaches outside (sends, publishes or charges) · asks a person to confirm when Era runs it

• Canonical address: POST /api/v1/actions/voice.start_call

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.call_started

What it writes: voice_call (insert) — Queues the call

curl -X POST https://app.getera.io/api/v1/voice_calls/actions/start_call \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"voiceAgentId":"VOICE_AGENT_ID","to":"Number"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "voice.call_started"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.voiceCalls.startCall({
  voiceAgentId: "VOICE_AGENT_ID",
  to: "Number"
})

era voice_calls start_call \
  --voice-agent-id "VOICE_AGENT_ID" \
  --to "Number"

{
  "name": "era__voice__start_call",
  "arguments": {
    "voiceAgentId": "VOICE_AGENT_ID",
    "to": "Number"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold voice:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 voice_not_found, voice_off, outbound_off, bad_number, no_phone_line, whatsapp_calling_off, minutes_used_up, outbound_limit, no_source, budget_exceeded · 429 slow down

voice.start_whatsapp_call

Call someone on WhatsApp with Era — Era calls a person on your computer’s WhatsApp, talks to them about what you asked, hangs up and tells you how it went — summary, outcome, transcript.

Needs voice:write · reaches outside (sends, publishes or charges)

• Canonical address: POST /api/v1/actions/voice.start_whatsapp_call

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.whatsapp_call_requested

What it writes: voice_call (insert) — Queues the call for the computer, with its reservation

curl -X POST https://app.getera.io/api/v1/voice_calls/actions/start_whatsapp_call \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"goal":"What to talk about"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "voice.whatsapp_call_requested"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.voiceCalls.startWhatsappCall({
  goal: "What to talk about"
})

era voice_calls start_whatsapp_call \
  --goal "What to talk about"

{
  "name": "era__voice__start_whatsapp_call",
  "arguments": {
    "goal": "What to talk about"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold voice:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 whatsapp_line_off, whatsapp_outbound_off, no_one_to_call, bad_number, voice_not_found, voice_off, minutes_used_up, outbound_limit, no_source, budget_exceeded · 429 slow down

voice.take_over_whatsapp_call

Take the WhatsApp call over from Era — “Devral”: Era stops talking and the call’s sound goes back to your own microphone and speakers on the computer.

Needs voice:write · reaches outside (sends, publishes or charges)

• Canonical address: POST /api/v1/actions/voice.take_over_whatsapp_call

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.whatsapp_takeover

What it writes: voice_call (update) — Marks the moment; the computer hands the sound back

curl -X POST https://app.getera.io/api/v1/voice_calls/VOICE_CALL_ID/actions/take_over_whatsapp_call \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "voice.whatsapp_takeover"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.voiceCalls.takeOverWhatsappCall("VOICE_CALL_ID")

era voice_calls take_over_whatsapp_call VOICE_CALL_ID

{
  "name": "era__voice__take_over_whatsapp_call",
  "arguments": {
    "id": "VOICE_CALL_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold voice:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 call_not_live · 429 slow down

voice.update

Change an Era’s voice — Voice, greeting, language, opening-hours behaviour, transfer number, abilities, knowledge and where it answers.

Needs voice:manage · changes data

• REST alias: PATCH /api/v1/voice_agents/{id}
• Canonical address: POST /api/v1/actions/voice.update

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.agent_changed

What it writes: voice_agent (update) — Writes the settings and marks the provider copy for re-sync

curl -X POST https://app.getera.io/api/v1/voice_agents/VOICE_AGENT_ID/actions/update \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"inboxId":"INBOX_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "voice.agent_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.voiceAgents.update("VOICE_AGENT_ID", {
  inboxId: "INBOX_ID"
})

era voice_agents update VOICE_AGENT_ID \
  --inbox-id "INBOX_ID"

{
  "name": "era__voice__update",
  "arguments": {
    "id": "VOICE_AGENT_ID",
    "inboxId": "INBOX_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold voice:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 voice_not_found, inbox_not_voice, inbox_taken, unknown_tool, bad_transfer_number, transfer_needs_number, unknown_language, unknown_knowledge_base, site_not_found · 429 slow down

voice.whatsapp_ring

A WhatsApp call is ringing on the computer — Era Desktop reports a ringing WhatsApp call; the line’s rule says whether Era answers it, leaves it to you, or a workflow decides. Machine-only.

Needs voice:handle · reaches outside (sends, publishes or charges)

• Canonical address: POST /api/v1/actions/voice.whatsapp_ring

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: voice.whatsapp_ringing

What it writes: voice_call (insert) — A ringing WhatsApp call with Era’s decision

Errors: 401 no or expired credential · 403 the credential does not hold voice:handle · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 whatsapp_line_off, wrong_computer, voice_not_found, voice_off · 429 slow down

Data models

VoiceAgent

Table voice_agent · Resource voice_agents

• GET /api/v1/voice_agents
• GET /api/v1/voice_agents/{id}
• PATCH /api/v1/voice_agents/{id} → voice.update

Primary key: id

Checks:

• CHECK (((after_hours_message IS NULL) OR (length(after_hours_message) <= 600)))
• CHECK ((approval_tools <@ tools))
• CHECK ((length(greeting) <= 600))
• CHECK ((language ~ '^[a-z]{2}(-[A-Z]{2})?$'::text))
• CHECK (((max_call_minutes >= 1) AND (max_call_minutes <= 60)))
• CHECK ((payer = 'own_key'::text))
• CHECK ((length(persona) <= 4000))
• CHECK (((sync_error IS NULL) OR (length(sync_error) <= 600)))
• CHECK ((tools <@ ARRAY['check_availability'::text, 'book_appointment'::text, 'cancel_appointment'::text, 'order_status'::text, 'capture_lead'::text, 'answer_question'::text, 'take_message'::text, 'transfer_to_human'::text]))
• CHECK (((transfer_number IS NULL) OR (transfer_number ~ '^\+[1-9][0-9]{6,14}$'::text)))
• CHECK (((whatsapp_error IS NULL) OR (length(whatsapp_error) <= 600)))
• CHECK (((widget_label IS NULL) OR (length(widget_label) <= 60)))

VoiceCall

Table voice_call · Resource voice_calls

• GET /api/v1/voice_calls
• GET /api/v1/voice_calls/{id}

Primary key: id

Checks:

• CHECK ((jsonb_typeof(actions) = 'array'::text))
• CHECK (((bridge IS NULL) OR (bridge = ANY (ARRAY['twilio'::text, 'sip'::text, 'elevenlabs'::text, 'whatsapp_sip'::text, 'desktop'::text, 'web'::text]))))
• CHECK ((duration_sec >= 0))
• CHECK (((error IS NULL) OR (length(error) <= 600)))
• CHECK ((jsonb_typeof(memory) = 'object'::text))
• CHECK (((outcome IS NULL) OR (outcome = ANY (ARRAY['booked'::text, 'cancelled'::text, 'lead'::text, 'message'::text, 'answered'::text, 'transferred'::text, 'no_action'::text, 'failed'::text]))))
• CHECK (((payer IS NULL) OR (payer = 'own_key'::text))) NOT VALID
• CHECK (((purpose IS NULL) OR (length(purpose) <= 1000)))
• CHECK (((ring_decision IS NULL) OR (ring_decision = ANY (ARRAY['answer'::text, 'ignore'::text, 'wait'::text]))))
• CHECK (((ring_reason IS NULL) OR (length(ring_reason) <= 300)))
• CHECK (((source_kind IS NULL) OR (source_kind = ANY (ARRAY['native'::text, 'byos'::text, 'byok'::text])))) NOT VALID
• CHECK ((jsonb_typeof(transcript) = 'array'::text))

VoiceWhatsappLine

Table voice_whatsapp_line · Resource voice_whatsapp_lines

• GET /api/v1/voice_whatsapp_lines
• GET /api/v1/voice_whatsapp_lines/{id}

Primary key: id

Checks:

• CHECK (((owner_name IS NULL) OR (length(owner_name) <= 120)))
• CHECK (((ring_seconds >= 0) AND (ring_seconds <= 40)))

Events

Workflows and webhooks react to these events.