Skip to main content
GET
cURL

Usage

  1. Call GET /api/v1/voices with filters for your agent phone market and language.
  2. Pick a row from voices[].
  3. Copy voices[i].selectedVoice exactly into POST or PATCH /api/v1/inbound-agents.
  4. Set primaryLanguage to selectedVoice.language.code (optional if you pass selectedVoice - Ondial syncs it).

Query parameters

Response

Each voice row includes:
  • selectedVoice - ready-to-POST object (name, displayName, gender, language, tier, accent, playbackSpeed)
  • languageCode - locale used in selectedVoice.language.code
  • allowedTiers - which tiers this tenant may use

Example

Errors

Alternatives

  • Omit selectedVoice on create - Ondial assigns a default voice for the agent phone + primaryLanguage.
  • Set copyVoiceFromAgentId instead of selectedVoice to clone from another inbound agent.

Authorizations

Authorization
string
header
required

Paste only your API key (ond_live_… or ond_test_…). Do not type the word Bearer - the playground adds it.

Query Parameters

market
enum<string>
default:IN
Available options:
IN,
INTL
phoneNumber
string

Optional E.164 agent phone. When set without market, auto-selects IN vs INTL catalog.

Example:

"+919876543210"

tier
enum<string>
default:premium
Available options:
standard,
premium,
elite,
all
language
string

BCP-47 filter (full code or language prefix), e.g. hi-IN or hi

Example:

"hi-IN"

gender
enum<string>

Optional picker filter

Available options:
male,
female

Response

Voice catalog

market
enum<string>
Available options:
IN,
INTL
tier
string
allowedTiers
object
Example:
languages
object[]
voices
object[]
count
integer