Skip to main content
An AI Voice Agent is a Ringee-owned configuration projected to the voice provider. Saving an agent rebuilds that provider configuration from the stored row, its type blueprint and the active workspace.

Agent types and variables

Variables describe the person and the reason for one call. Required values must be present and unknown variable names are rejected.

Appointment Booking

Possible outcomes: meeting_booked, callback_scheduled, not_interested, no_answer, no_conversation, wrong_number, unknown. The agent may offer only slots returned by Ringee’s live availability tool and may report a meeting as booked only after the booking tool succeeds. Google and Microsoft calendars are optional sync targets; their absence does not block the agent.

Reminders & Notifications

Possible outcomes: confirmed, cannot_attend, callback_scheduled, not_interested, no_answer, no_conversation, wrong_number, unknown. This type does not reschedule an appointment. When the person needs a change or asks for a human, it creates a human-support notification for the workspace.

Model choices

The exact model behind each choice comes from the self-hosted deployment’s AI_VOICE_AGENT_*_MODEL settings and is returned by GET /api/ai-voice-agents/models.
An API key is write-only. Ringee never returns it and does not store the plaintext key in its database. To replace it, submit a new key.

Voices and language

Ringee curates conversational voices in English (en), Spanish (es), Portuguese (pt), French (fr), German (de) and Italian (it). Up to 8 voices are returned per locale. The selected voice’s language controls the type’s default greeting and instructions. Use the preview endpoint or the dashboard player before the first real call. Voice previews are generated audio and can incur provider usage for the deployment, so Ringee caches them in the API process.

Company context

Each agent can carry its own company name, website and description. When those values are empty, Ringee falls back to the workspace company profile. This lets one organization operate agents for multiple brands without changing the shared fallback. Ringee can generate a draft description from a public website. The URL fetch rejects private and local network targets.

Caller number

You can assign a default Ringee number to the agent or choose one on each call. At call time Ringee resolves the caller number in this order:
  1. fromNumberId supplied for this call;
  2. the number assigned to the agent;
  3. the workspace’s only eligible number, but only when exactly one exists.
If several numbers are available and no choice can be resolved, Ringee refuses the call instead of guessing.

Conversation settings

You can change:
  • when the assistant speaks: assistant_speaks_first, assistant_generates_greeting or assistant_waits_for_user;
  • the greeting;
  • the main instructions;
  • whether post-conversation instructions run;
  • post-conversation instructions.
Safety instructions supplied by the agent type remain in effect when you replace the editable prompt. For example, an Appointment Booking agent still cannot invent availability.

Status lifecycle

Saving an eligible draft normally activates it. A disabled agent stays disabled after edits until you explicitly activate it. Call readiness is checked again immediately before every call.

Next steps

Knowledge and analysis

Ground responses and extract structured data

Calls and results

Trigger calls and interpret their lifecycle