{"openapi":"3.1.0","info":{"title":"Entrovox Developer API","description":"Programmatic access to the Entrovox calling platform. Authenticate with `Authorization: ApiKey sk_entrovox_…` (agency call API).\n\n**Webhooks** (see the Webhooks section) are a preview: the contract is stable, but delivery is not active yet — poll `GET /calls/{id}` for outcomes for now.","version":"v1"},"paths":{"/leads":{"get":{"tags":["Leads"],"summary":"List leads","description":"List leads, or look one up by your ``external_id``.\n\nAPI keys get the partner lead shape with `status_url` / `calls_url` on\nevery row; a campaign-bound key sees only its campaign. `screen_status` is\nnot supported here: the partner list refuses it rather than ignore it.","operationId":"list_leads_v1_leads_get","parameters":[{"name":"lead_source_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Source Id"}},{"name":"disposition","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Disposition"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Search"}},{"name":"external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}],"title":"External Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"screen_status","in":"query","required":false,"schema":{"anyOf":[{"enum":["flagged","blocked"],"type":"string"},{"type":"null"}],"title":"Screen Status"}}],"responses":{"200":{"description":"A page of leads (no calls).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerLeadPage"}}}},"422":{"description":"VALIDATION_ERROR: a required parameter is missing or has the wrong type (param names it). See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"400":{"description":"VALIDATION_ERROR: a malformed cursor or filter (param names it). See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"403":{"description":"INSUFFICIENT_SCOPE, API_KEY_ENDPOINT_NOT_ALLOWED, LEAD_SOURCE_NOT_ALLOWED. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."}}},"post":{"tags":["Leads"],"summary":"Create a lead","description":"Post one lead into a campaign.\n\nAPI keys: ``external_id`` is required; ``201`` enrolls the lead, a retry with\nthe same ``external_id`` (same phone, campaign and ``is_test``) replays it\nwith ``200`` and ``X-Duplicate: external_id``. DNC, invalid phone, a paused\nor inactive campaign and invalid consent are ``4xx`` with no row. Send an\n``Idempotency-Key`` (UUID) to make transport retries safe.","operationId":"create_lead_v1_leads_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"PartnerLeadWrite","description":"One lead as an API key posts it (``POST /v1/leads``, each batch item).","properties":{"lead_source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Source Id"},"first_name":{"maxLength":200,"minLength":1,"title":"First Name","type":"string"},"last_name":{"maxLength":200,"minLength":1,"title":"Last Name","type":"string"},"phone":{"maxLength":32,"minLength":1,"title":"Phone","type":"string"},"external_id":{"anyOf":[{"maxLength":128,"minLength":1,"type":"string"},{"type":"null"}],"description":"Your lead id. Unique per organization; a retry with it replays the lead.","title":"External Id"},"is_test":{"default":false,"description":"true stores a test lead (a safe hello-world): it is never enrolled, dialed or texted, never blocks a live phone, and is not listed. Read it back by id.","title":"Is Test","type":"boolean"},"transfer_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Not supported yet: any value is rejected with 400 VALIDATION_ERROR (param transfer_phone). Qualified leads transfer to the campaign number.","title":"Transfer Phone"},"phone_alt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Alt"},"email":{"anyOf":[{"maxLength":320,"type":"string"},{"type":"null"}],"title":"Email"},"state":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"title":"State"},"zip_code":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"title":"Zip Code"},"timezone":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"title":"Timezone"},"preferred_language":{"anyOf":[{"enum":["en","es"],"type":"string"},{"type":"null"}],"title":"Preferred Language"},"lead_generated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Generated At"},"owned_line_of_business":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"title":"Owned Line Of Business"},"target_line_of_business":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"title":"Target Line Of Business"},"trustedform_cert_url":{"anyOf":[{"maxLength":512,"type":"string"},{"type":"null"}],"title":"Trustedform Cert Url"},"jornaya_leadid":{"anyOf":[{"maxLength":256,"type":"string"},{"type":"null"}],"title":"Jornaya Leadid"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"required":["first_name","last_name","phone","external_id"],"type":"object"}}}},"responses":{"201":{"description":"Created and enrolled. A draft campaign is accepted and paused (not dialed). A retry with the same Idempotency-Key and body returns this response unchanged (X-Idempotency-Replayed: true).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerLeadEnvelope"}}}},"422":{"description":"VALIDATION_ERROR: a required field (e.g. external_id) is missing, or the body is not a JSON object. A field with a wrong value is 400. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"200":{"description":"Replay: same external_id, phone, campaign and is_test (data.replayed true, X-Duplicate: external_id). A lead that never enrolled, or that a duplicate check parked, is refused instead (400 DNC_BLOCKED / 409 LEAD_PHONE_CONFLICT).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerLeadEnvelope"}}}},"400":{"description":"Never accepted, no row: VALIDATION_ERROR, DNC_BLOCKED, SOURCE_PAUSED (paused campaign), SOURCE_INACTIVE (completed or otherwise not live; a draft campaign is accepted and paused instead), CONSENT_INVALID, CROSS_SELL_PAIR_INVALID. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"403":{"description":"INSUFFICIENT_SCOPE, API_KEY_ENDPOINT_NOT_ALLOWED, LEAD_SOURCE_NOT_ALLOWED. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"404":{"description":"LEAD_SOURCE_NOT_FOUND. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"409":{"description":"EXTERNAL_ID_CONFLICT, LEAD_PHONE_CONFLICT, IDEMPOTENCY_KEY_REUSED, IDEMPOTENCY_IN_PROGRESS. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"503":{"description":"PROVIDER_UNAVAILABLE: no row; honor Retry-After. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."}}}},"/leads/batch":{"post":{"tags":["Leads"],"summary":"Create leads in a batch","description":"Post up to 500 leads.\n\nAPI keys: ``200`` with ``items``, one per input row in order, whatever the mix\nof ``created`` / ``replayed`` / ``conflict`` / ``rejected``. A row with code\n``PROVIDER_UNAVAILABLE`` created nothing and is safe to resend in a new batch.\nSend an ``Idempotency-Key`` (UUID) to replay the whole response on a retry.","operationId":"batch_create_leads_v1_leads_batch_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"PartnerBatchWrite","description":"Documentation model for the batch request body an API key sends.","properties":{"lead_source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Campaign id. Optional when the key is bound to a campaign.","title":"Lead Source Id"},"leads":{"items":{"$ref":"#/components/schemas/PartnerLeadWrite"},"maxItems":500,"minItems":1,"title":"Leads","type":"array"}},"required":["leads"],"type":"object"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataResponse_BatchCreateLeadsResponse_"}}}},"422":{"description":"VALIDATION_ERROR: leads is missing, empty, over 500 rows or not an array, or an unbound key sent no lead_source_id. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"200":{"description":"Always, when the request itself is well-formed: partial success is in items, one per input row in input order (a batch where every row failed is still 200). A row with code PROVIDER_UNAVAILABLE created nothing and is safe to resend in a new batch; its external_id makes that idempotent. A retry with the same Idempotency-Key and body returns this response unchanged (X-Idempotency-Replayed: true).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerBatchResult"}}}},"400":{"description":"VALIDATION_ERROR: Idempotency-Key is not a UUID, or lead_source_id is not a campaign id (param names it). See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"403":{"description":"INSUFFICIENT_SCOPE, API_KEY_ENDPOINT_NOT_ALLOWED, LEAD_SOURCE_NOT_ALLOWED. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"404":{"description":"LEAD_SOURCE_NOT_FOUND: lead_source_id is not a campaign in your organization; no row is created. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"409":{"description":"IDEMPOTENCY_KEY_REUSED, IDEMPOTENCY_IN_PROGRESS. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."}}}},"/leads/ping":{"post":{"tags":["Leads"],"summary":"Ping a lead","description":"Would this lead be taken right now? Creates nothing. API keys only.\n\n``200`` ``{accepted, reason, queued_reason, lead_source_id}``; ``accepted: false``\nis the never-accepted class. An unknown campaign is the post's ``404``; a DNC\ncheck that could not run is ``503 PROVIDER_UNAVAILABLE``. Takes no idempotency\nreservation; an ``Idempotency-Key`` header is ignored.","operationId":"ping_lead_v1_leads_ping_post","requestBody":{"content":{"application/json":{"schema":{"properties":{"phone":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Phone"},"state":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"State"},"zip_code":{"anyOf":[{"type":"string","maxLength":10},{"type":"null"}],"title":"Zip Code"},"target_line_of_business":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Target Line Of Business"},"lead_source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Source Id"},"external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1},{"type":"null"}],"title":"External Id","description":"Correlation only. A lead in this campaign with the same external_id holding the phone counts as a replay, so it is accepted. Not stored or echoed."}},"type":"object","title":"PartnerLeadPing","description":"The ping request body: every field optional, same names as the lead write."}}},"required":false},"responses":{"200":{"description":"Always, when the request is well-formed: accepted false with a reason is the never-accepted class (dnc, already_enrolled, source_inactive, source_paused, invalid_phone; consent_invalid is reserved). accepted true may carry a queued_reason (outside_hours, missing_geography; capacity is reserved). Nothing is created or reserved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPingResult"}}}},"422":{"description":"VALIDATION_ERROR: the body is not a JSON object, or an unbound key sent no lead_source_id. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"400":{"description":"VALIDATION_ERROR: a field has the wrong type, or lead_source_id is not a campaign id (param names it). See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"403":{"description":"INSUFFICIENT_SCOPE, API_KEY_ENDPOINT_NOT_ALLOWED, LEAD_SOURCE_NOT_ALLOWED. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"404":{"description":"LEAD_SOURCE_NOT_FOUND: lead_source_id is not a campaign in your organization. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"503":{"description":"PROVIDER_UNAVAILABLE: our DNC check could not run; honor Retry-After. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."}}}},"/leads/{lead_id}":{"get":{"tags":["Leads"],"summary":"Retrieve a lead","description":"The lead's status URL: current disposition, schedule, and call attempts.\n\nAPI keys get the partner shape with ``calls[]`` (transcript, recording and\nanalysis links per attempt). A campaign-bound key gets ``404`` for a lead\noutside its campaign.","operationId":"get_lead_v1_leads__lead_id__get","parameters":[{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","title":"Lead Id"}}],"responses":{"200":{"description":"The status URL: the lead and its call attempts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerLeadEnvelope"}}}},"422":{"description":"VALIDATION_ERROR: a required parameter is missing or has the wrong type (param names it). See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"403":{"description":"INSUFFICIENT_SCOPE, API_KEY_ENDPOINT_NOT_ALLOWED. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"404":{"description":"LEAD_NOT_FOUND. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."}}}},"/leads/{lead_id}/calls":{"get":{"tags":["Leads"],"summary":"List calls for a lead","description":"Every call attempt for the lead, oldest first, with transcript,\nrecording and analysis links. Cursor-paginated.","operationId":"list_lead_calls_v1_leads__lead_id__calls_get","parameters":[{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","title":"Lead Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"A page of the lead's call attempts, oldest first.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCallPage"}}}},"422":{"description":"VALIDATION_ERROR: a required parameter is missing or has the wrong type (param names it). See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"400":{"description":"VALIDATION_ERROR: a malformed cursor or filter (param names it). See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"403":{"description":"INSUFFICIENT_SCOPE, API_KEY_ENDPOINT_NOT_ALLOWED. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"404":{"description":"LEAD_NOT_FOUND. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."}}}},"/leads/{lead_id}/pause":{"post":{"tags":["Leads"],"summary":"Pause a lead","description":"Pause the calling sequence for a single lead.\n\nAtomic across all of the lead's active lead_source_leads rows.  Idempotent:\nre-pausing returns ``already_paused=True`` with ``updated_count=0``. A call\nalready ringing is not killed.\n\nReturns 404 if the lead is not in the caller's org (or, for a\ncampaign-bound key, not in its campaign).\nReturns 409 if the lead has no active sequence (already terminal).","operationId":"pause_lead_v1_leads__lead_id__pause_post","parameters":[{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","title":"Lead Id"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"PauseLeadRequest","description":"POST /v1/leads/{lead_id}/pause body.","properties":{"reason":{"anyOf":[{"maxLength":140,"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object"}}},"required":false},"responses":{"200":{"description":"Paused (or already paused).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPauseEnvelope"}}}},"422":{"description":"VALIDATION_ERROR: a required parameter is missing or has the wrong type (param names it). See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"400":{"description":"VALIDATION_ERROR: reason is not valid, or is a reason Entrovox uses for automatic pauses (param reason). See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"403":{"description":"INSUFFICIENT_SCOPE, API_KEY_ENDPOINT_NOT_ALLOWED. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"404":{"description":"LEAD_NOT_FOUND. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"409":{"description":"LEAD_NOT_PAUSEABLE, LEAD_ENROLLED_ELSEWHERE. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."}}}},"/leads/{lead_id}/resume":{"post":{"tags":["Leads"],"summary":"Resume a lead","description":"Resume the calling sequence for a single lead.\n\n``next_attempt_at`` respects calling-windows so resume at 11pm local\ntime does not trigger an immediate out-of-window dial.  Idempotent:\nre-resuming returns ``already_resumed=True`` with ``updated_count=0``.\n\nReturns 404 if the lead is not in the caller's org (or, for a\ncampaign-bound key, not in its campaign).","operationId":"resume_lead_v1_leads__lead_id__resume_post","parameters":[{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","title":"Lead Id"}}],"responses":{"200":{"description":"Resumed (or already running).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerResumeEnvelope"}}}},"422":{"description":"VALIDATION_ERROR: a required parameter is missing or has the wrong type (param names it). See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"403":{"description":"INSUFFICIENT_SCOPE, API_KEY_ENDPOINT_NOT_ALLOWED. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"404":{"description":"LEAD_NOT_FOUND. See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."},"409":{"description":"LEAD_ENROLLED_ELSEWHERE, LEAD_PAUSED_BY_AGENCY (a campaign key may lift only a pause an API key set). See the error catalog. Every error carries error.code, message and request_id; lead-specific codes add doc_url, and param when a field failed."}}}},"/calls":{"post":{"tags":["Calls"],"summary":"Create a call","description":"Initiate an outbound call with a specific AI voice agent.\n\nNot available to campaign-bound partner keys, which post leads instead\n(``POST /v1/leads``).\n\nPass an `Idempotency-Key` header to make retries safe: a repeated key with the\nsame body returns the original response instead of placing a second call. The\nsame key with a different body is refused with `409 IDEMPOTENCY_KEY_REUSED`.","operationId":"create_call_v1_calls_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataResponse_CreateCallResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Calls"],"summary":"List calls","description":"List calls, newest first. Filter by lead source, status, disposition,\noutcome, direction, date range, and duration.","operationId":"list_calls_v1_calls_get","parameters":[{"name":"lead_source_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Source Id"}},{"name":"lead_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Id"}},{"name":"direction","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Direction"}},{"name":"disposition","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Disposition"}},{"name":"call_outcome","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Outcome"}},{"name":"routing_mode","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(agent|forward)$"},{"type":"null"}],"description":"Filter by inbound call routing mode: 'agent' or 'forward'.","title":"Routing Mode"},"description":"Filter by inbound call routing mode: 'agent' or 'forward'."},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date To"}},{"name":"min_duration","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Min Duration"}},{"name":"max_duration","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Max Duration"}},{"name":"outcome_group","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by call group: conversations | transferred | callbacks_in | voicemails | all. Expands to a set of call_outcome values; 'all'/unknown applies no outcome filter. Omit for the classic single-outcome behavior.","title":"Outcome Group"},"description":"Filter by call group: conversations | transferred | callbacks_in | voicemails | all. Expands to a set of call_outcome values; 'all'/unknown applies no outcome filter. Omit for the classic single-outcome behavior."},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}],"description":"Search across calls: matches the lead's name, the call id, and — when the term contains digits — the digit-stripped from/to numbers, over the full filtered set. Selects the offset-paged path.","title":"Q"},"description":"Search across calls: matches the lead's name, the call id, and — when the term contains digits — the digit-stripped from/to numbers, over the full filtered set. Selects the offset-paged path."},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(when|duration|lead)$"},{"type":"null"}],"description":"Sort column: when=initiated_at, duration=duration_seconds, lead=the displayed lead-name-else-number. Selects the offset-paged path; default 'when'.","title":"Sort By"},"description":"Sort column: when=initiated_at, duration=duration_seconds, lead=the displayed lead-name-else-number. Selects the offset-paged path; default 'when'."},{"name":"sort_dir","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(asc|desc)$"},{"type":"null"}],"description":"Sort direction for sort_by (default desc). Selects the offset-paged path.","title":"Sort Dir"},"description":"Sort direction for sort_by (default desc). Selects the offset-paged path."},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1000000,"minimum":0},{"type":"null"}],"description":"Offset paging. Any of q/sort_by/sort_dir/offset selects the offset-paged path: meta.next_cursor is null and paging is offset+limit against meta.total. Omit all four for the classic cursor path.","title":"Offset"},"description":"Offset paging. Any of q/sort_by/sort_dir/offset selects the offset-paged path: meta.next_cursor is null and paging is offset+limit against meta.total. Omit all four for the classic cursor path."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Classic cursor paging. Ignored whenever any of q/sort_by/sort_dir/offset is present (the offset-paged path takes precedence).","title":"Cursor"},"description":"Classic cursor paging. Ignored whenever any of q/sort_by/sort_dir/offset is present (the offset-paged path takes precedence)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorResponse_CallSummary_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/calls/stats":{"get":{"tags":["Calls"],"summary":"Retrieve call statistics","description":"Aggregate call statistics (total, connected, transfers, average durations, screener), computed over the full filtered set.\n\nAccepts the same filters as `GET /v1/calls`, so the figures agree with the list.","operationId":"get_call_stats_v1_calls_stats_get","parameters":[{"name":"lead_source_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Source Id"}},{"name":"lead_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Id"}},{"name":"direction","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Direction"}},{"name":"disposition","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Disposition"}},{"name":"call_outcome","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Outcome"}},{"name":"routing_mode","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(agent|forward)$"},{"type":"null"}],"description":"Filter by inbound call routing mode: 'agent' or 'forward'.","title":"Routing Mode"},"description":"Filter by inbound call routing mode: 'agent' or 'forward'."},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date To"}},{"name":"min_duration","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Min Duration"}},{"name":"max_duration","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Max Duration"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataResponse_CallStats_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/calls/{call_id}":{"get":{"tags":["Calls"],"summary":"Retrieve a call","description":"Get a single call's status, disposition, and details.","operationId":"get_call_v1_calls__call_id__get","parameters":[{"name":"call_id","in":"path","required":true,"schema":{"type":"string","title":"Call Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataResponse_CallDetail_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/calls/{call_id}/analysis":{"get":{"tags":["Calls"],"summary":"Retrieve a call analysis","description":"Get the post-call AI analysis (summary and outcome) for a call.","operationId":"get_call_analysis_v1_calls__call_id__analysis_get","parameters":[{"name":"call_id","in":"path","required":true,"schema":{"type":"string","title":"Call Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataResponse_CallAnalysisResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/calls/{call_id}/transcript":{"get":{"tags":["Calls"],"summary":"Retrieve a call transcript","description":"Get the full transcript for a call.","operationId":"get_call_transcript_v1_calls__call_id__transcript_get","parameters":[{"name":"call_id","in":"path","required":true,"schema":{"type":"string","title":"Call Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataResponse_CallTranscriptResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/calls/{call_id}/recording-url":{"get":{"tags":["Calls"],"summary":"Retrieve a call recording URL","description":"Generate a signed URL for the call recording.\n\nReturns a short-lived (1 hour) signed URL for the recording's audio file. With no `format` the response is exactly `{\"url\": ...}`. `format=m4a` serves an AAC copy that Apple devices can play, made on demand; the response then also carries `format`. `503 RECORDING_TRANSCODE_FAILED` (retryable, the original recording is still available) means the copy could not be made.\n\nIf there is no file to serve, `404 RECORDING_NOT_FOUND` means the call has no recording and retrying will not help. `404 RECORDING_NOT_READY` means a recording is still being processed: retry after `Retry-After`; partner subscriptions can also wait for `call.recording.ready` once webhook delivery is live. `503 RECORDING_UNAVAILABLE` is a temporary failure: retry after `Retry-After`.","operationId":"get_recording_url_v1_calls__call_id__recording_url_get","parameters":[{"name":"call_id","in":"path","required":true,"schema":{"type":"string","title":"Call Id"}},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"enum":["ogg","m4a"],"type":"string"},{"type":"null"}],"description":"`ogg` (the default, and what every client that omits this gets) or `m4a` (AAC in MP4, for iOS). The response names the format actually served; an `m4a` request is answered with `ogg` for a recording over the size cap.","title":"Format"},"description":"`ogg` (the default, and what every client that omits this gets) or `m4a` (AAC in MP4, for iOS). The response names the format actually served; an `m4a` request is answered with `ogg` for a recording over the size cap."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordingUrlEnvelope"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/phone-numbers":{"get":{"tags":["Phone numbers"],"summary":"List phone numbers","description":"List your phone numbers. Use a number's `id` as the `from_number_id`\n(the caller ID) when initiating a call.","operationId":"list_phone_numbers_v1_phone_numbers_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Page Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponse_PhoneNumberResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/phone-numbers/{phone_number_id}":{"get":{"tags":["Phone numbers"],"summary":"Retrieve a phone number","description":"Get one phone number by id.","operationId":"get_phone_number_v1_phone_numbers__phone_number_id__get","parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","title":"Phone Number Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataResponse_PhoneNumberResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/voice-agents":{"get":{"tags":["AI voice agents"],"summary":"List AI voice agents","description":"List your AI voice agents. Use an agent's `id` as the `agent_id` when\ninitiating a call.","operationId":"list_voice_agents_v1_voice_agents_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"line_of_business","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line Of Business"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Per Page"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponse_VoiceAgentSummary_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/voice-agents/{agent_id}":{"get":{"tags":["AI voice agents"],"summary":"Retrieve an AI voice agent","description":"Get one AI voice agent by id.","operationId":"get_voice_agent_v1_voice_agents__agent_id__get","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataResponse_VoiceAgentDetail_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"servers":[{"url":"https://api.entrovox.com/v1"}],"components":{"schemas":{"AgentOverrides":{"properties":{"system_prompt_append":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}],"title":"System Prompt Append"},"temperature":{"anyOf":[{"type":"number","maximum":2.0,"minimum":0.0},{"type":"null"}],"title":"Temperature"},"voice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voice Id"},"max_duration_seconds":{"anyOf":[{"type":"integer","maximum":3600.0,"minimum":30.0},{"type":"null"}],"title":"Max Duration Seconds","description":"Hard cap in seconds for this call. Shortens the plugin session cap. Cannot extend a call past that cap."},"tools":{"anyOf":[{"$ref":"#/components/schemas/AgentToolOverrides"},{"type":"null"}]}},"type":"object","title":"AgentOverrides"},"AgentToolOverrides":{"properties":{"enable":{"items":{"type":"string"},"type":"array","title":"Enable"},"disable":{"items":{"type":"string"},"type":"array","title":"Disable"}},"type":"object","title":"AgentToolOverrides"},"BatchCreateLeadsResponse":{"properties":{"lead_source_id":{"type":"string","title":"Lead Source Id"},"created":{"type":"integer","title":"Created"},"deduplicated":{"type":"integer","title":"Deduplicated"},"errors":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Errors"}},"type":"object","required":["lead_source_id","created","deduplicated"],"title":"BatchCreateLeadsResponse"},"CallAnalysisResponse":{"properties":{"id":{"type":"string","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"call_id":{"type":"string","title":"Call Id"},"call_outcome":{"type":"string","title":"Call Outcome"},"outcome_confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Outcome Confidence"},"outcome_reasoning":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Outcome Reasoning"},"overall_sentiment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Overall Sentiment"},"sentiment_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sentiment Score"},"dnc_detected":{"type":"boolean","title":"Dnc Detected","default":false},"dnc_phrases":{"items":{"type":"string"},"type":"array","title":"Dnc Phrases"},"dnc_action_taken":{"type":"boolean","title":"Dnc Action Taken","default":false},"callback_detected":{"type":"boolean","title":"Callback Detected","default":false},"callback_datetime":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Callback Datetime"},"callback_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Callback Notes"},"callback_action_taken":{"type":"boolean","title":"Callback Action Taken","default":false},"wrong_number_detected":{"type":"boolean","title":"Wrong Number Detected","default":false},"wrong_number_action_taken":{"type":"boolean","title":"Wrong Number Action Taken","default":false},"not_available_detected":{"type":"boolean","title":"Not Available Detected","default":false},"not_available_who":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Not Available Who"},"competitors_mentioned":{"items":{"type":"string"},"type":"array","title":"Competitors Mentioned"},"objections":{"items":{"$ref":"#/components/schemas/ObjectionEntry"},"type":"array","title":"Objections"},"extracted_data":{"additionalProperties":true,"type":"object","title":"Extracted Data"},"call_summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Summary"},"follow_up_actions":{"items":{"type":"string"},"type":"array","title":"Follow Up Actions"},"model_used":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Used"},"prompt_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt Version"},"analysis_duration_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Analysis Duration Ms"},"token_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Token Count"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","organization_id","call_id","call_outcome","created_at","updated_at"],"title":"CallAnalysisResponse"},"CallDetail":{"properties":{"id":{"type":"string","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"lead_source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Source Id"},"lead_source_lead_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Source Lead Id"},"lead_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Id"},"lead_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Name"},"lead_source_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Source Name"},"lead_source_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Source Type"},"why_short":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Why Short"},"why_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Why Detail"},"origin":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Origin"},"direction":{"type":"string","title":"Direction"},"status":{"type":"string","title":"Status"},"attempt_number":{"type":"integer","title":"Attempt Number","default":1},"from_number":{"type":"string","title":"From Number"},"to_number":{"type":"string","title":"To Number"},"initiated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Initiated At"},"answered_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Answered At"},"ended_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Ended At"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"scheduled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Scheduled At"},"duration_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration Seconds"},"talk_time_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Talk Time Seconds"},"disposition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Disposition"},"call_outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Outcome"},"call_summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Summary"},"analysis_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Analysis Status"},"language":{"type":"string","title":"Language","default":"en"},"qualification_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Qualification Data"},"qualification_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Qualification Score"},"ai_disclosure_delivered":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ai Disclosure Delivered","default":false},"recording_disclosed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Recording Disclosed","default":false},"voicemail_clip_used":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Voicemail Clip Used"},"screener_detected":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Screener Detected","default":false},"screener_result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Screener Result"},"recording_duration_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Recording Duration Seconds"},"transcript":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcript"},"transcript_json":{"anyOf":[{"items":{},"type":"array"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Transcript Json"},"ai_latency_p50_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ai Latency P50 Ms"},"ai_latency_p95_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ai Latency P95 Ms"},"agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Id"},"variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Variables"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"retry_config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Retry Config"},"scheduling":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Scheduling"},"agent_overrides":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Agent Overrides"},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Url"},"webhook_events":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Webhook Events"},"sequence_step":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sequence Step"},"transfer_context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Transfer Context"},"disconnect_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Disconnect Reason"},"is_short_drop":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Short Drop","default":false},"had_dead_air":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Had Dead Air","default":false},"is_test":{"type":"boolean","title":"Is Test","default":false},"human_recording_suppressed":{"type":"boolean","title":"Human Recording Suppressed","default":false},"routing_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Routing Mode"},"forwarded_to_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forwarded To Number"},"forward_answered":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Forward Answered"},"ai_talk_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ai Talk Seconds"},"wait_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Wait Seconds"},"human_talk_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Human Talk Seconds"},"wait_ring_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Wait Ring Seconds"},"wait_hold_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Wait Hold Seconds"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["id","organization_id","direction","status","from_number","to_number"],"title":"CallDetail"},"CallStats":{"properties":{"total":{"type":"integer","title":"Total","default":0},"connected":{"type":"integer","title":"Connected","default":0},"transfers":{"type":"integer","title":"Transfers","default":0},"avg_duration_seconds":{"type":"number","title":"Avg Duration Seconds","default":0.0},"avg_transfer_duration_seconds":{"type":"number","title":"Avg Transfer Duration Seconds","default":0.0},"screener_passed":{"type":"integer","title":"Screener Passed","default":0},"screener_blocked":{"type":"integer","title":"Screener Blocked","default":0}},"type":"object","title":"CallStats","description":"Aggregate call statistics (`GET /v1/calls/stats`), computed over the full filtered set."},"CallSummary":{"properties":{"id":{"type":"string","title":"Id"},"lead_source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Source Id"},"lead_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Id"},"lead_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Name"},"lead_source_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Source Name"},"lead_source_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Source Type"},"attempt_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Attempt Number"},"sequence_step":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sequence Step"},"why_short":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Why Short"},"direction":{"type":"string","title":"Direction"},"status":{"type":"string","title":"Status"},"disposition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Disposition"},"call_outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Outcome"},"from_number":{"type":"string","title":"From Number"},"to_number":{"type":"string","title":"To Number"},"initiated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Initiated At"},"answered_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Answered At"},"ended_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Ended At"},"duration_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration Seconds"},"screener_detected":{"type":"boolean","title":"Screener Detected","default":false},"screener_result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Screener Result"},"is_gtm_demo":{"type":"boolean","title":"Is Gtm Demo","default":false},"is_test":{"type":"boolean","title":"Is Test","default":false},"summary_short":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary Short"},"language":{"type":"string","title":"Language","default":"en"},"disconnect_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Disconnect Reason"},"routing_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Routing Mode"},"forwarded_to_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forwarded To Number"},"ai_talk_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ai Talk Seconds"},"wait_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Wait Seconds"},"human_talk_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Human Talk Seconds"},"wait_ring_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Wait Ring Seconds"},"wait_hold_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Wait Hold Seconds"}},"type":"object","required":["id","direction","status","from_number","to_number"],"title":"CallSummary"},"CallTranscriptResponse":{"properties":{"call_id":{"type":"string","title":"Call Id"},"transcript":{"items":{"$ref":"#/components/schemas/TranscriptEntry"},"type":"array","title":"Transcript"},"word_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Word Count"}},"type":"object","required":["call_id","transcript"],"title":"CallTranscriptResponse"},"CreateCallRequest":{"properties":{"to_number":{"type":"string","maxLength":20,"minLength":2,"title":"To Number"},"from_number_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Number Id","description":"The id of one of your phone numbers, used as the caller ID. One of from_number_id or from_number is required; send either one."},"from_number":{"anyOf":[{"type":"string","maxLength":20,"minLength":2},{"type":"null"}],"title":"From Number","description":"The caller ID to dial from, in E.164. One of from_number or from_number_id is required; send either one."},"agent_id":{"type":"string","minLength":1,"title":"Agent Id"},"lead_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Id"},"lead_source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Source Id"},"lead_source_lead_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Source Lead Id"},"is_test":{"type":"boolean","title":"Is Test","default":false},"variables":{"additionalProperties":{"type":"string"},"type":"object","title":"Variables"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"},"retry_config":{"anyOf":[{"$ref":"#/components/schemas/RetryConfig"},{"type":"null"}]},"scheduling":{"anyOf":[{"$ref":"#/components/schemas/SchedulingConfig"},{"type":"null"}]},"agent_overrides":{"anyOf":[{"$ref":"#/components/schemas/AgentOverrides"},{"type":"null"}]},"webhook_url":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}],"title":"Webhook Url"},"webhook_events":{"items":{"type":"string"},"type":"array","title":"Webhook Events"},"owned_line_of_business":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Owned Line Of Business"},"target_line_of_business":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Target Line Of Business"}},"type":"object","required":["to_number","agent_id"],"title":"CreateCallRequest"},"CreateCallResponse":{"properties":{"id":{"type":"string","title":"Id"},"status":{"type":"string","title":"Status"},"to_number":{"type":"string","title":"To Number"},"from_number":{"type":"string","title":"From Number"},"agent_id":{"type":"string","title":"Agent Id"},"scheduled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Scheduled At"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","status","to_number","from_number","agent_id","created_at"],"title":"CreateCallResponse"},"CursorMeta":{"properties":{"total":{"type":"integer","title":"Total"},"limit":{"type":"integer","title":"Limit"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["total","limit","has_more"],"title":"CursorMeta"},"CursorResponse_CallSummary_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CallSummary"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/CursorMeta"}},"type":"object","required":["data","meta"],"title":"CursorResponse[CallSummary]"},"DataResponse_BatchCreateLeadsResponse_":{"properties":{"data":{"$ref":"#/components/schemas/BatchCreateLeadsResponse"}},"type":"object","required":["data"],"title":"DataResponse[BatchCreateLeadsResponse]"},"DataResponse_CallAnalysisResponse_":{"properties":{"data":{"$ref":"#/components/schemas/CallAnalysisResponse"}},"type":"object","required":["data"],"title":"DataResponse[CallAnalysisResponse]"},"DataResponse_CallDetail_":{"properties":{"data":{"$ref":"#/components/schemas/CallDetail"}},"type":"object","required":["data"],"title":"DataResponse[CallDetail]"},"DataResponse_CallStats_":{"properties":{"data":{"$ref":"#/components/schemas/CallStats"}},"type":"object","required":["data"],"title":"DataResponse[CallStats]"},"DataResponse_CallTranscriptResponse_":{"properties":{"data":{"$ref":"#/components/schemas/CallTranscriptResponse"}},"type":"object","required":["data"],"title":"DataResponse[CallTranscriptResponse]"},"DataResponse_CreateCallResponse_":{"properties":{"data":{"$ref":"#/components/schemas/CreateCallResponse"}},"type":"object","required":["data"],"title":"DataResponse[CreateCallResponse]"},"DataResponse_PhoneNumberResponse_":{"properties":{"data":{"$ref":"#/components/schemas/PhoneNumberResponse"}},"type":"object","required":["data"],"title":"DataResponse[PhoneNumberResponse]"},"DataResponse_VoiceAgentDetail_":{"properties":{"data":{"$ref":"#/components/schemas/VoiceAgentDetail"}},"type":"object","required":["data"],"title":"DataResponse[VoiceAgentDetail]"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HiyaMetrics":{"properties":{"maturity":{"anyOf":[{"type":"string","enum":["good","normal","poor","very_poor"]},{"type":"null"}],"title":"Maturity"},"desirability":{"anyOf":[{"type":"string","enum":["good","normal","poor","very_poor"]},{"type":"null"}],"title":"Desirability"},"engagement":{"anyOf":[{"type":"string","enum":["good","normal","poor","very_poor"]},{"type":"null"}],"title":"Engagement"},"reaction":{"anyOf":[{"type":"string","enum":["good","normal","poor","very_poor"]},{"type":"null"}],"title":"Reaction"}},"type":"object","title":"HiyaMetrics"},"HiyaRegistration":{"properties":{"state":{"type":"string","enum":["queued","verified","failed"],"title":"State","default":"queued"},"queued_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Queued At"},"verified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verified At"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error","description":"The provider's last error message, if any."}},"type":"object","title":"HiyaRegistration"},"HiyaReputation":{"properties":{"registration":{"$ref":"#/components/schemas/HiyaRegistration"},"reputation":{"$ref":"#/components/schemas/HiyaReputationDetail"},"source":{"type":"string","const":"hiya","title":"Source","default":"hiya"},"checked_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checked At"},"last_attempt_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Attempt At"},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Error","description":"The provider's last error message, if any."}},"type":"object","title":"HiyaReputation"},"HiyaReputationDetail":{"properties":{"spam_status":{"anyOf":[{"type":"string","enum":["unflagged","mixed_low","mixed_high","flagged"]},{"type":"null"}],"title":"Spam Status"},"category":{"anyOf":[{"type":"string","enum":["spam","fraud"]},{"type":"null"}],"title":"Category"},"metrics":{"$ref":"#/components/schemas/HiyaMetrics"}},"type":"object","title":"HiyaReputationDetail"},"ObjectionEntry":{"properties":{"type":{"type":"string","title":"Type"},"phrase":{"type":"string","title":"Phrase"},"agent_response":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Response"}},"type":"object","required":["type","phrase"],"title":"ObjectionEntry"},"PagedResponse_PhoneNumberResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PhoneNumberResponse"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PagedResponse[PhoneNumberResponse]"},"PagedResponse_VoiceAgentSummary_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/VoiceAgentSummary"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PagedResponse[VoiceAgentSummary]"},"PaginationMeta":{"properties":{"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"per_page":{"type":"integer","title":"Per Page"},"total_pages":{"type":"integer","title":"Total Pages"}},"type":"object","required":["total","page","per_page","total_pages"],"title":"PaginationMeta"},"PartnerPingResult":{"description":"The ping response (top level, not under ``data``).","properties":{"accepted":{"description":"False only for the never-accepted class.","title":"Accepted","type":"boolean"},"reason":{"anyOf":[{"enum":["dnc","already_enrolled","source_inactive","source_paused","invalid_phone","consent_invalid"],"type":"string"},{"type":"null"}],"default":null,"description":"Why it would not be accepted. consent_invalid is reserved: ping carries no consent certificate, so it is not returned yet.","title":"Reason"},"queued_reason":{"anyOf":[{"enum":["outside_hours","capacity","missing_geography"],"type":"string"},{"type":"null"}],"default":null,"description":"Set only when accepted is true but the first dial will wait. capacity is reserved and not returned yet.","title":"Queued Reason"},"lead_source_id":{"description":"The campaign evaluated.","title":"Lead Source Id","type":"string"}},"required":["accepted","lead_source_id"],"title":"PartnerPingResult","type":"object"},"PhoneNumberResponse":{"properties":{"id":{"type":"string","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"phone_number":{"type":"string","title":"Phone Number"},"friendly_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Friendly Name"},"caller_id_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Caller Id Name"},"source":{"type":"string","title":"Source"},"status":{"type":"string","title":"Status"},"provider":{"type":"string","enum":["telnyx","twilio","vonage"],"title":"Provider","default":"telnyx"},"verified":{"type":"boolean","title":"Verified"},"capabilities":{"items":{"type":"string"},"type":"array","title":"Capabilities"},"inbound_agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inbound Agent Id"},"outbound_agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Outbound Agent Id"},"inbound_routing_mode":{"type":"string","enum":["agent","forward"],"title":"Inbound Routing Mode"},"forwarding_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forwarding Phone"},"forwarding_announcement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forwarding Announcement"},"inbound_transfer_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inbound Transfer Phone"},"spanish_transfer_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Spanish Transfer Phone"},"inbound_after_hours_ai_enabled":{"type":"boolean","title":"Inbound After Hours Ai Enabled","default":false},"forwarding_use_org_default":{"type":"boolean","title":"Forwarding Use Org Default","default":false},"inbound_transfer_use_org_default":{"type":"boolean","title":"Inbound Transfer Use Org Default","default":false},"reputation_score":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reputation Score"},"reputation_level":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reputation Level"},"hiya_reputation":{"anyOf":[{"$ref":"#/components/schemas/HiyaReputation"},{"type":"null"}]},"outbound_quarantined":{"type":"boolean","title":"Outbound Quarantined","default":false},"quarantine_source":{"anyOf":[{"type":"string","enum":["hiya","behavioral","manual","autopilot"]},{"type":"null"}],"title":"Quarantine Source"},"quarantined_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quarantined At"},"quarantine_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quarantine Reason"},"quarantine_confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Quarantine Confidence"},"reputation_state":{"type":"string","enum":["clean","cooldown"],"title":"Reputation State","default":"clean"},"cooldown_entered_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cooldown Entered At"},"cooldown_source":{"anyOf":[{"type":"string","enum":["hiya","behavioral"]},{"type":"null"}],"title":"Cooldown Source"},"number_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number Type"},"monthly_cost_cents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Monthly Cost Cents"},"country_code":{"type":"string","title":"Country Code"},"pool_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pool Id"},"pool_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pool Name"},"pool_stage":{"type":"string","enum":["onboarding","onboarding_failed","reserve","dialing","quarantine","releasing"],"title":"Pool Stage","default":"dialing"},"ready_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ready At"},"release_after":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Release After"},"show_logo_on_outbound":{"type":"boolean","title":"Show Logo On Outbound","default":false},"show_logo_opt_out":{"type":"boolean","title":"Show Logo Opt Out","default":false},"created_at":{"type":"string","title":"Created At"},"updated_at":{"type":"string","title":"Updated At"}},"type":"object","required":["id","organization_id","phone_number","friendly_name","caller_id_name","source","status","verified","capabilities","inbound_agent_id","outbound_agent_id","inbound_routing_mode","forwarding_phone","forwarding_announcement","inbound_transfer_phone","reputation_score","reputation_level","number_type","monthly_cost_cents","country_code","created_at","updated_at"],"title":"PhoneNumberResponse"},"RetryConfig":{"properties":{"max_attempts":{"type":"integer","maximum":10.0,"minimum":1.0,"title":"Max Attempts","default":3},"delay_minutes":{"type":"integer","maximum":1440.0,"minimum":1.0,"title":"Delay Minutes","default":30},"retry_on":{"items":{"type":"string"},"type":"array","title":"Retry On"}},"type":"object","title":"RetryConfig"},"SchedulingConfig":{"properties":{"scheduled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Scheduled At"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","examples":["America/New_York"]},"respect_tcpa_windows":{"type":"boolean","title":"Respect Tcpa Windows","default":true}},"type":"object","title":"SchedulingConfig"},"TranscriptEntry":{"properties":{"speaker":{"type":"string","title":"Speaker"},"text":{"type":"string","title":"Text"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"duration_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration Ms"}},"type":"object","required":["speaker","text"],"title":"TranscriptEntry"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VoiceAgentDetail":{"properties":{"id":{"type":"string","title":"Id"},"organization_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organization Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"voice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voice Id"},"screener_response":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Screener Response"},"spoken_agency_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Spoken Agency Name"},"call_handling_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Handling Instructions"},"call_objective":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Objective"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"voicemail_mode":{"type":"string","title":"Voicemail Mode","default":"drop"},"voicemail_message_template":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voicemail Message Template"},"voicemail_message_template_es":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voicemail Message Template Es"},"background_sound":{"type":"string","title":"Background Sound","default":"none"},"expressive_mode":{"type":"boolean","title":"Expressive Mode","default":false},"prompt_mode":{"type":"string","title":"Prompt Mode","default":"assembled"},"custom_system_prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom System Prompt"},"opening_line":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Opening Line"},"opening_line_inbound":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Opening Line Inbound"},"opening_line_es":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Opening Line Es"},"parent_agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Agent Id"},"persona":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Persona"},"flow_config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Flow Config"},"compliance_config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Compliance Config"},"qualification_criteria":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Qualification Criteria"},"tool_policy":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Tool Policy"},"runtime_config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Runtime Config"},"llm_provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Llm Provider"},"llm_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Llm Model"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"},"objective":{"type":"string","title":"Objective","default":"lead_qualification"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","created_at","updated_at"],"title":"VoiceAgentDetail"},"VoiceAgentSummary":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"voice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voice Id"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"line_of_business":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line Of Business"},"prompt_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt Mode"},"objective":{"type":"string","title":"Objective","default":"lead_qualification"},"is_builtin":{"type":"boolean","title":"Is Builtin","default":false},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","name","created_at"],"title":"VoiceAgentSummary"},"PartnerLeadWrite":{"description":"One lead as an API key posts it (``POST /v1/leads``, each batch item).","properties":{"lead_source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Source Id"},"first_name":{"maxLength":200,"minLength":1,"title":"First Name","type":"string","description":"Not blank. A blank value is 400 VALIDATION_ERROR."},"last_name":{"maxLength":200,"minLength":1,"title":"Last Name","type":"string","description":"Not blank. A blank value is 400 VALIDATION_ERROR."},"phone":{"maxLength":32,"minLength":1,"title":"Phone","type":"string","description":"E.164 for a US or Canadian number: +1 then 10 digits, like +14255551234. Anything else is 400 VALIDATION_ERROR."},"external_id":{"anyOf":[{"maxLength":128,"minLength":1,"type":"string"},{"type":"null"}],"description":"Your lead id. Unique per organization; a retry with it replays the lead.","title":"External Id"},"is_test":{"default":false,"description":"true stores a test lead (a safe hello-world): it is never enrolled, dialed or texted, never blocks a live phone, and is not listed. Read it back by id.","title":"Is Test","type":"boolean"},"transfer_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Not supported yet: any value is rejected with 400 VALIDATION_ERROR (param transfer_phone). Qualified leads transfer to the campaign number.","title":"Transfer Phone"},"phone_alt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Alt","description":"A second number, in the same form as phone: +1 then 10 digits. Anything else is 400 VALIDATION_ERROR."},"email":{"anyOf":[{"maxLength":320,"type":"string"},{"type":"null"}],"title":"Email"},"state":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"title":"State"},"zip_code":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"title":"Zip Code"},"timezone":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"title":"Timezone","description":"An IANA time zone such as America/Los_Angeles, and one that state uses. Omit it and we derive it from zip_code or state. Anything else is 400 VALIDATION_ERROR."},"preferred_language":{"anyOf":[{"enum":["en","es"],"type":"string"},{"type":"null"}],"title":"Preferred Language"},"lead_generated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Generated At"},"owned_line_of_business":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"title":"Owned Line Of Business"},"target_line_of_business":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"title":"Target Line Of Business"},"trustedform_cert_url":{"anyOf":[{"maxLength":512,"type":"string"},{"type":"null"}],"title":"Trustedform Cert Url","description":"The https://cert.trustedform.com/<certificate id> URL from your form (40 hex characters). Anything else is 400 CONSENT_INVALID."},"jornaya_leadid":{"anyOf":[{"maxLength":256,"type":"string"},{"type":"null"}],"title":"Jornaya Leadid"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"Your own key and value pairs, stored and echoed unchanged. At most 64 KB and 32 levels deep, with finite numbers and UTF-8 text without NUL characters. Otherwise 400 VALIDATION_ERROR."}},"required":["first_name","last_name","phone","external_id"],"title":"PartnerLeadWrite","type":"object"},"PartnerCallSummary":{"properties":{"id":{"title":"Id","type":"string"},"attempt_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Attempt Number"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Status"},"disposition":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Disposition"},"call_outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Call Outcome"},"duration_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Duration Seconds"},"started_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Started At"},"ended_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Ended At"},"transcript_url":{"title":"Transcript Url","type":"string"},"recording_url":{"title":"Recording Url","type":"string"},"analysis_url":{"title":"Analysis Url","type":"string"}},"required":["id","transcript_url","recording_url","analysis_url"],"title":"PartnerCallSummary","type":"object"},"PartnerLead":{"properties":{"id":{"title":"Id","type":"string"},"organization_id":{"title":"Organization Id","type":"string"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"External Id"},"status_url":{"title":"Status Url","type":"string"},"calls_url":{"title":"Calls Url","type":"string"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Last Name"},"phone":{"title":"Phone","type":"string"},"phone_alt":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Phone Alt"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Email"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"State"},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Zip Code"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Timezone"},"preferred_language":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Preferred Language"},"transfer_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Always null for now.","title":"Transfer Phone"},"is_test":{"default":false,"title":"Is Test","type":"boolean"},"trustedform_cert_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Trustedform Cert Url"},"jornaya_leadid":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Jornaya Leadid"},"metadata":{"additionalProperties":true,"title":"Metadata","type":"object"},"current_disposition":{"title":"Current Disposition","type":"string"},"disposition_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Disposition At"},"is_dnc":{"default":false,"title":"Is Dnc","type":"boolean"},"national_dnc_status":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"National Dnc Status"},"attempt_count":{"default":0,"title":"Attempt Count","type":"integer"},"last_attempted_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Last Attempted At"},"next_attempt_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Next Attempt At"},"sequence_step":{"default":0,"title":"Sequence Step","type":"integer"},"sequence_status":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Sequence Status"},"paused":{"default":false,"title":"Paused","type":"boolean"},"paused_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Paused At"},"paused_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Paused Reason"},"pause_is_queued":{"default":false,"title":"Pause Is Queued","type":"boolean"},"dedup_status":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Dedup Status"},"dial_blocker":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Dial Blocker"},"replayed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"On POST responses: true on a 200 replay.","title":"Replayed"},"calls":{"anyOf":[{"items":{"$ref":"#/components/schemas/PartnerCallSummary"},"type":"array"},{"type":"null"}],"default":null,"description":"Every attempt, newest last. On GET /leads/{id} and POST responses.","title":"Calls"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","organization_id","status_url","calls_url","phone","current_disposition","created_at","updated_at"],"title":"PartnerLead","type":"object"},"PartnerLeadEnvelope":{"properties":{"data":{"$ref":"#/components/schemas/PartnerLead"}},"required":["data"],"title":"PartnerLeadEnvelope","type":"object"},"PartnerBatchItem":{"properties":{"index":{"description":"Position of the row in the request's leads array.","title":"Index","type":"integer"},"status":{"enum":["created","replayed","conflict","rejected"],"title":"Status","type":"string"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"External Id"},"lead_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Set on created and replayed rows.","title":"Lead Id"},"status_url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Set on created and replayed rows.","title":"Status Url"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Set on conflict and rejected rows.","title":"Code"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Set on conflict and rejected rows.","title":"Message"}},"required":["index","status"],"title":"PartnerBatchItem","type":"object"},"PartnerBatchResult":{"description":"The batch response: one item per input row, same order, never truncated.","properties":{"lead_source_id":{"title":"Lead Source Id","type":"string"},"created":{"title":"Created","type":"integer"},"replayed":{"title":"Replayed","type":"integer"},"rejected":{"description":"Rows with status rejected or conflict.","title":"Rejected","type":"integer"},"items":{"items":{"$ref":"#/components/schemas/PartnerBatchItem"},"title":"Items","type":"array"}},"required":["lead_source_id","created","replayed","rejected","items"],"title":"PartnerBatchResult","type":"object"},"_Meta":{"properties":{"total":{"title":"Total","type":"integer"},"limit":{"title":"Limit","type":"integer"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Next Cursor"},"has_more":{"title":"Has More","type":"boolean"}},"required":["total","limit","has_more"],"title":"_Meta","type":"object"},"PartnerLeadPage":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PartnerLead"},"title":"Data","type":"array"},"meta":{"$ref":"#/components/schemas/_Meta"}},"required":["data","meta"],"title":"PartnerLeadPage","type":"object"},"PartnerCallPage":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PartnerCallSummary"},"title":"Data","type":"array"},"meta":{"$ref":"#/components/schemas/_Meta"}},"required":["data","meta"],"title":"PartnerCallPage","type":"object"},"PartnerPauseResult":{"properties":{"paused_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Paused At"},"paused_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Paused Reason"},"updated_count":{"title":"Updated Count","type":"integer"},"already_paused":{"title":"Already Paused","type":"boolean"}},"required":["updated_count","already_paused"],"title":"PartnerPauseResult","type":"object"},"PartnerPauseEnvelope":{"properties":{"data":{"$ref":"#/components/schemas/PartnerPauseResult"}},"required":["data"],"title":"PartnerPauseEnvelope","type":"object"},"PartnerResumeResult":{"properties":{"resumed_at":{"format":"date-time","title":"Resumed At","type":"string"},"next_attempt_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Next Attempt At"},"updated_count":{"title":"Updated Count","type":"integer"},"already_resumed":{"title":"Already Resumed","type":"boolean"}},"required":["resumed_at","updated_count","already_resumed"],"title":"PartnerResumeResult","type":"object"},"PartnerResumeEnvelope":{"properties":{"data":{"$ref":"#/components/schemas/PartnerResumeResult"}},"required":["data"],"title":"PartnerResumeEnvelope","type":"object"},"RecordingUrl":{"type":"object","title":"RecordingUrl","description":"A short-lived signed URL for the call's recording.","required":["url"],"properties":{"url":{"type":"string","title":"Url","description":"Signed URL for the audio file. It expires after 1 hour."},"format":{"type":"string","enum":["ogg","m4a"],"title":"Format","description":"The format actually served. Present only when the request named a format; an m4a request for a recording over the size cap is answered with ogg."}}},"RecordingUrlEnvelope":{"type":"object","title":"RecordingUrlEnvelope","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RecordingUrl"}}}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Format: `Authorization: ApiKey <key>`"}}},"webhooks":{"lead.accepted":{"post":{"summary":"lead.accepted","description":"Partner only. Entrovox enrolled the lead you posted. Persist `lead.id` and `status_url`. `data.lead` is the full Lead object (the example is abbreviated). Not final.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Standard Webhooks message id (the event `id`, `evt_...`). Stable across retries: dedupe on it.","schema":{"type":"string","example":"evt_01J8XYZ"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when the delivery was signed. Reject if it is more than 300 seconds from your clock.","schema":{"type":"string","example":"1789063561"}},{"name":"webhook-signature","in":"header","required":true,"description":"One or more space-separated `v1,<base64 signature>` entries (several appear during secret rotation). Verify with a Standard Webhooks library first (Python: `Webhook(secret).verify(body, headers)` from `standardwebhooks`). To verify by hand: the HMAC-SHA256 key is the base64-decoded part of your `whsec_` signing secret after the prefix; sign `{webhook-id}.{webhook-timestamp}.{raw body bytes}` exactly, base64-encode the digest, and compare it in constant time against each `v1,` entry. Reject timestamps outside the 300 second window.","schema":{"type":"string","example":"v1,<base64 HMAC-SHA256 signature> (illustrative)"}}],"x-audience":"partner","x-final":false,"requestBody":{"required":true,"content":{"application/json":{"example":{"id":"evt_01J8XYZ","type":"lead.accepted","created_at":"2026-09-10T18:06:01Z","api_version":"2026-09-10","data":{"lead":{"id":"lead_01J8","status_url":"https://api.entrovox.com/v1/leads/lead_01J8"},"external_id":"crm-lead-42"}}}}},"responses":{"200":{"description":"Acknowledge with any 2xx within ~5s and process asynchronously. Non-2xx or timeout is retried with exponential backoff (~5 attempts over a few hours)."}}}},"call.completed":{"post":{"summary":"call.completed","description":"The call reached a terminal state; carries `status` + `disposition` (qualified_transfer | transferred | declined | no_answer | voicemail | callback_scheduled | connected_other). Provisional, not final: summary and media arrive later. Agency `webhook_url` callbacks carry `data` exactly as in the example; partner subscriptions add the fields listed in `x-partner-data`.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Standard Webhooks message id (the event `id`, `evt_...`). Stable across retries: dedupe on it.","schema":{"type":"string","example":"evt_01J8XYZ"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when the delivery was signed. Reject if it is more than 300 seconds from your clock.","schema":{"type":"string","example":"1789063561"}},{"name":"webhook-signature","in":"header","required":true,"description":"One or more space-separated `v1,<base64 signature>` entries (several appear during secret rotation). Verify with a Standard Webhooks library first (Python: `Webhook(secret).verify(body, headers)` from `standardwebhooks`). To verify by hand: the HMAC-SHA256 key is the base64-decoded part of your `whsec_` signing secret after the prefix; sign `{webhook-id}.{webhook-timestamp}.{raw body bytes}` exactly, base64-encode the digest, and compare it in constant time against each `v1,` entry. Reject timestamps outside the 300 second window.","schema":{"type":"string","example":"v1,<base64 HMAC-SHA256 signature> (illustrative)"}}],"x-audience":"all","x-final":false,"requestBody":{"required":true,"content":{"application/json":{"example":{"id":"evt_01J8XYZ","type":"call.completed","created_at":"2026-09-10T18:06:01Z","api_version":"2026-09-10","data":{"call":{"id":"call_01J8","status":"completed","direction":"outbound","to_number":"+15555551234","from_number":"+15555550000","agent_id":"agent_01J8","disposition":"declined","duration_seconds":73,"talk_time_seconds":58,"answered_at":"2026-09-10T18:05:10Z","ended_at":"2026-09-10T18:06:23Z","metadata":{"crm_id":"lead-42"}},"analysis_pending":true}}}}},"responses":{"200":{"description":"Acknowledge with any 2xx within ~5s and process asynchronously. Non-2xx or timeout is retried with exponential backoff (~5 attempts over a few hours)."}},"x-partner-data":{"call":{"id":"call_01J8","status":"completed","direction":"outbound","to_number":"+15555551234","from_number":"+15555550000","agent_id":"agent_01J8","disposition":"declined","duration_seconds":73,"talk_time_seconds":58,"answered_at":"2026-09-10T18:05:10Z","ended_at":"2026-09-10T18:06:23Z","metadata":{"crm_id":"lead-42"}},"external_id":"crm-lead-42","analysis_pending":true,"media_pending":true}}},"call.transferred":{"post":{"summary":"call.transferred","description":"A warm transfer to a licensed agent connected (the hot handoff). Fires during the call. Carries the transfer result. Not final. Agency `webhook_url` callbacks carry `data` exactly as in the example; partner subscriptions add the fields listed in `x-partner-data`.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Standard Webhooks message id (the event `id`, `evt_...`). Stable across retries: dedupe on it.","schema":{"type":"string","example":"evt_01J8XYZ"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when the delivery was signed. Reject if it is more than 300 seconds from your clock.","schema":{"type":"string","example":"1789063561"}},{"name":"webhook-signature","in":"header","required":true,"description":"One or more space-separated `v1,<base64 signature>` entries (several appear during secret rotation). Verify with a Standard Webhooks library first (Python: `Webhook(secret).verify(body, headers)` from `standardwebhooks`). To verify by hand: the HMAC-SHA256 key is the base64-decoded part of your `whsec_` signing secret after the prefix; sign `{webhook-id}.{webhook-timestamp}.{raw body bytes}` exactly, base64-encode the digest, and compare it in constant time against each `v1,` entry. Reject timestamps outside the 300 second window.","schema":{"type":"string","example":"v1,<base64 HMAC-SHA256 signature> (illustrative)"}}],"x-audience":"all","x-final":false,"requestBody":{"required":true,"content":{"application/json":{"example":{"id":"evt_01J8XYZ","type":"call.transferred","created_at":"2026-09-10T18:06:01Z","api_version":"2026-09-10","data":{"call":{"id":"call_01J8","status":"in_progress","direction":"outbound","to_number":"+15555551234","from_number":"+15555550000","agent_id":"agent_01J8","disposition":"qualified_transfer","duration_seconds":73,"talk_time_seconds":58,"answered_at":"2026-09-10T18:05:10Z","ended_at":"2026-09-10T18:06:23Z","metadata":{"crm_id":"lead-42"}},"transfer":{"status":"connected","to_agent":"Jane (Acme Insurance)","initiated_at":"2026-09-10T18:05:50Z","connected_at":"2026-09-10T18:05:58Z"}}}}}},"responses":{"200":{"description":"Acknowledge with any 2xx within ~5s and process asynchronously. Non-2xx or timeout is retried with exponential backoff (~5 attempts over a few hours)."}},"x-partner-data":{"call":{"id":"call_01J8","status":"in_progress","direction":"outbound","to_number":"+15555551234","from_number":"+15555550000","agent_id":"agent_01J8","disposition":"qualified_transfer","duration_seconds":73,"talk_time_seconds":58,"answered_at":"2026-09-10T18:05:10Z","ended_at":"2026-09-10T18:06:23Z","metadata":{"crm_id":"lead-42"}},"external_id":"crm-lead-42","transfer":{"status":"connected","to_number":"+15555559999","initiated_at":"2026-09-10T18:05:50Z","connected_at":"2026-09-10T18:05:58Z","human_talk_seconds":41}}}},"call.analysis.completed":{"post":{"summary":"call.analysis.completed","description":"The post-call AI summary, qualification, transcript and recording links are ready (arrives after call.completed). Recording/transcript are links you fetch on demand, so no expiring URLs sit in your webhook logs. For agency `webhook_url` callbacks this is the last event of the call. Partner subscriptions: not final while `media_pending` is true; wait for call.recording.ready. Agency `webhook_url` callbacks carry `data` exactly as in the example; partner subscriptions add the fields listed in `x-partner-data`.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Standard Webhooks message id (the event `id`, `evt_...`). Stable across retries: dedupe on it.","schema":{"type":"string","example":"evt_01J8XYZ"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when the delivery was signed. Reject if it is more than 300 seconds from your clock.","schema":{"type":"string","example":"1789063561"}},{"name":"webhook-signature","in":"header","required":true,"description":"One or more space-separated `v1,<base64 signature>` entries (several appear during secret rotation). Verify with a Standard Webhooks library first (Python: `Webhook(secret).verify(body, headers)` from `standardwebhooks`). To verify by hand: the HMAC-SHA256 key is the base64-decoded part of your `whsec_` signing secret after the prefix; sign `{webhook-id}.{webhook-timestamp}.{raw body bytes}` exactly, base64-encode the digest, and compare it in constant time against each `v1,` entry. Reject timestamps outside the 300 second window.","schema":{"type":"string","example":"v1,<base64 HMAC-SHA256 signature> (illustrative)"}}],"x-audience":"all","x-final":false,"requestBody":{"required":true,"content":{"application/json":{"example":{"id":"evt_01J8XYZ","type":"call.analysis.completed","created_at":"2026-09-10T18:06:01Z","api_version":"2026-09-10","data":{"call_id":"call_01J8","analysis":{"summary":"Shopping auto+home bundle; renewal in 3 weeks; with Geico.","outcome":"qualified_transfer","qualification_score":0.82,"qualification_data":{"line_of_business":"auto","current_carrier":"Geico"}},"links":{"recording":"https://api.entrovox.com/v1/calls/call_01J8/recording-url","transcript":"https://api.entrovox.com/v1/calls/call_01J8/transcript"}}}}}},"responses":{"200":{"description":"Acknowledge with any 2xx within ~5s and process asynchronously. Non-2xx or timeout is retried with exponential backoff (~5 attempts over a few hours)."}},"x-partner-data":{"call_id":"call_01J8","external_id":"crm-lead-42","analysis":{"summary":"Shopping auto+home bundle; renewal in 3 weeks; with Geico.","outcome":"qualified_transfer","qualification_score":0.82,"qualification_data":{"line_of_business":"auto","current_carrier":"Geico"}},"links":{"recording":"https://api.entrovox.com/v1/calls/call_01J8/recording-url","transcript":"https://api.entrovox.com/v1/calls/call_01J8/transcript"},"media_pending":true}}},"call.recording.ready":{"post":{"summary":"call.recording.ready","description":"Partner only. The recording and transcript are fetchable. This is the one final event: write your disposition and artifacts to your LMS here. `status` is `uploaded` or `failed`. `links` are Entrovox API paths (fetch with your API key), not expiring signed URLs. `x-final` describes the partner contract; `x-audience` says who receives the event; agency `webhook_url` callbacks end at call.analysis.completed.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Standard Webhooks message id (the event `id`, `evt_...`). Stable across retries: dedupe on it.","schema":{"type":"string","example":"evt_01J8XYZ"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when the delivery was signed. Reject if it is more than 300 seconds from your clock.","schema":{"type":"string","example":"1789063561"}},{"name":"webhook-signature","in":"header","required":true,"description":"One or more space-separated `v1,<base64 signature>` entries (several appear during secret rotation). Verify with a Standard Webhooks library first (Python: `Webhook(secret).verify(body, headers)` from `standardwebhooks`). To verify by hand: the HMAC-SHA256 key is the base64-decoded part of your `whsec_` signing secret after the prefix; sign `{webhook-id}.{webhook-timestamp}.{raw body bytes}` exactly, base64-encode the digest, and compare it in constant time against each `v1,` entry. Reject timestamps outside the 300 second window.","schema":{"type":"string","example":"v1,<base64 HMAC-SHA256 signature> (illustrative)"}}],"x-audience":"partner","x-final":true,"requestBody":{"required":true,"content":{"application/json":{"example":{"id":"evt_01J8XYZ","type":"call.recording.ready","created_at":"2026-09-10T18:06:01Z","api_version":"2026-09-10","data":{"call_id":"call_01J8","external_id":"crm-lead-42","links":{"recording":"https://api.entrovox.com/v1/calls/call_01J8/recording-url","transcript":"https://api.entrovox.com/v1/calls/call_01J8/transcript"},"status":"uploaded"}}}}},"responses":{"200":{"description":"Acknowledge with any 2xx within ~5s and process asynchronously. Non-2xx or timeout is retried with exponential backoff (~5 attempts over a few hours)."}}}},"callback.scheduled":{"post":{"summary":"callback.scheduled","description":"Partner only. The lead asked to be called back. Show the appointment. Not final.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Standard Webhooks message id (the event `id`, `evt_...`). Stable across retries: dedupe on it.","schema":{"type":"string","example":"evt_01J8XYZ"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when the delivery was signed. Reject if it is more than 300 seconds from your clock.","schema":{"type":"string","example":"1789063561"}},{"name":"webhook-signature","in":"header","required":true,"description":"One or more space-separated `v1,<base64 signature>` entries (several appear during secret rotation). Verify with a Standard Webhooks library first (Python: `Webhook(secret).verify(body, headers)` from `standardwebhooks`). To verify by hand: the HMAC-SHA256 key is the base64-decoded part of your `whsec_` signing secret after the prefix; sign `{webhook-id}.{webhook-timestamp}.{raw body bytes}` exactly, base64-encode the digest, and compare it in constant time against each `v1,` entry. Reject timestamps outside the 300 second window.","schema":{"type":"string","example":"v1,<base64 HMAC-SHA256 signature> (illustrative)"}}],"x-audience":"partner","x-final":false,"requestBody":{"required":true,"content":{"application/json":{"example":{"id":"evt_01J8XYZ","type":"callback.scheduled","created_at":"2026-09-10T18:06:01Z","api_version":"2026-09-10","data":{"lead_id":"lead_01J8","call_id":"call_01J8","external_id":"crm-lead-42","callback_datetime":"2026-09-11T15:00:00","timezone":"America/Chicago"}}}}},"responses":{"200":{"description":"Acknowledge with any 2xx within ~5s and process asynchronously. Non-2xx or timeout is retried with exponential backoff (~5 attempts over a few hours)."}}}},"webhook.test":{"post":{"summary":"webhook.test","description":"Partner only. Sent by `POST /v1/webhooks/{id}/test` with a real signature so you can confirm verification before live leads. Ignore it as a lead event.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Standard Webhooks message id (the event `id`, `evt_...`). Stable across retries: dedupe on it.","schema":{"type":"string","example":"evt_01J8XYZ"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when the delivery was signed. Reject if it is more than 300 seconds from your clock.","schema":{"type":"string","example":"1789063561"}},{"name":"webhook-signature","in":"header","required":true,"description":"One or more space-separated `v1,<base64 signature>` entries (several appear during secret rotation). Verify with a Standard Webhooks library first (Python: `Webhook(secret).verify(body, headers)` from `standardwebhooks`). To verify by hand: the HMAC-SHA256 key is the base64-decoded part of your `whsec_` signing secret after the prefix; sign `{webhook-id}.{webhook-timestamp}.{raw body bytes}` exactly, base64-encode the digest, and compare it in constant time against each `v1,` entry. Reject timestamps outside the 300 second window.","schema":{"type":"string","example":"v1,<base64 HMAC-SHA256 signature> (illustrative)"}}],"x-audience":"partner","x-final":false,"requestBody":{"required":true,"content":{"application/json":{"example":{"id":"evt_01J8XYZ","type":"webhook.test","created_at":"2026-09-10T18:06:01Z","api_version":"2026-09-10","data":{"ok":true}}}}},"responses":{"200":{"description":"Acknowledge with any 2xx within ~5s and process asynchronously. Non-2xx or timeout is retried with exponential backoff (~5 attempts over a few hours)."}}}},"call.started":{"post":{"summary":"call.started","description":"The outbound dial was placed. Not final. Agency `webhook_url` callbacks carry `data` exactly as in the example; partner subscriptions add the fields listed in `x-partner-data`.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Standard Webhooks message id (the event `id`, `evt_...`). Stable across retries: dedupe on it.","schema":{"type":"string","example":"evt_01J8XYZ"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when the delivery was signed. Reject if it is more than 300 seconds from your clock.","schema":{"type":"string","example":"1789063561"}},{"name":"webhook-signature","in":"header","required":true,"description":"One or more space-separated `v1,<base64 signature>` entries (several appear during secret rotation). Verify with a Standard Webhooks library first (Python: `Webhook(secret).verify(body, headers)` from `standardwebhooks`). To verify by hand: the HMAC-SHA256 key is the base64-decoded part of your `whsec_` signing secret after the prefix; sign `{webhook-id}.{webhook-timestamp}.{raw body bytes}` exactly, base64-encode the digest, and compare it in constant time against each `v1,` entry. Reject timestamps outside the 300 second window.","schema":{"type":"string","example":"v1,<base64 HMAC-SHA256 signature> (illustrative)"}}],"x-audience":"all","x-final":false,"requestBody":{"required":true,"content":{"application/json":{"example":{"id":"evt_01J8XYZ","type":"call.started","created_at":"2026-09-10T18:06:01Z","api_version":"2026-09-10","data":{"call":{"id":"call_01J8","status":"queued","direction":"outbound","to_number":"+15555551234","from_number":"+15555550000","agent_id":"agent_01J8","disposition":null,"duration_seconds":null,"talk_time_seconds":null,"answered_at":null,"ended_at":null,"metadata":{"crm_id":"lead-42"}}}}}}},"responses":{"200":{"description":"Acknowledge with any 2xx within ~5s and process asynchronously. Non-2xx or timeout is retried with exponential backoff (~5 attempts over a few hours)."}},"x-partner-data":{"call":{"id":"call_01J8","status":"queued","direction":"outbound","to_number":"+15555551234","from_number":"+15555550000","agent_id":"agent_01J8","disposition":null,"duration_seconds":null,"talk_time_seconds":null,"answered_at":null,"ended_at":null,"metadata":{"crm_id":"lead-42"}},"external_id":"crm-lead-42"}}},"call.answered":{"post":{"summary":"call.answered","description":"The lead picked up; the AI conversation began. Not final. Agency `webhook_url` callbacks carry `data` exactly as in the example; partner subscriptions add the fields listed in `x-partner-data`.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Standard Webhooks message id (the event `id`, `evt_...`). Stable across retries: dedupe on it.","schema":{"type":"string","example":"evt_01J8XYZ"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when the delivery was signed. Reject if it is more than 300 seconds from your clock.","schema":{"type":"string","example":"1789063561"}},{"name":"webhook-signature","in":"header","required":true,"description":"One or more space-separated `v1,<base64 signature>` entries (several appear during secret rotation). Verify with a Standard Webhooks library first (Python: `Webhook(secret).verify(body, headers)` from `standardwebhooks`). To verify by hand: the HMAC-SHA256 key is the base64-decoded part of your `whsec_` signing secret after the prefix; sign `{webhook-id}.{webhook-timestamp}.{raw body bytes}` exactly, base64-encode the digest, and compare it in constant time against each `v1,` entry. Reject timestamps outside the 300 second window.","schema":{"type":"string","example":"v1,<base64 HMAC-SHA256 signature> (illustrative)"}}],"x-audience":"all","x-final":false,"requestBody":{"required":true,"content":{"application/json":{"example":{"id":"evt_01J8XYZ","type":"call.answered","created_at":"2026-09-10T18:06:01Z","api_version":"2026-09-10","data":{"call":{"id":"call_01J8","status":"in_progress","direction":"outbound","to_number":"+15555551234","from_number":"+15555550000","agent_id":"agent_01J8","disposition":null,"duration_seconds":null,"talk_time_seconds":null,"answered_at":"2026-09-10T18:05:10Z","ended_at":null,"metadata":{"crm_id":"lead-42"}}}}}}},"responses":{"200":{"description":"Acknowledge with any 2xx within ~5s and process asynchronously. Non-2xx or timeout is retried with exponential backoff (~5 attempts over a few hours)."}},"x-partner-data":{"call":{"id":"call_01J8","status":"in_progress","direction":"outbound","to_number":"+15555551234","from_number":"+15555550000","agent_id":"agent_01J8","disposition":null,"duration_seconds":null,"talk_time_seconds":null,"answered_at":"2026-09-10T18:05:10Z","ended_at":null,"metadata":{"crm_id":"lead-42"}},"external_id":"crm-lead-42"}}},"call.failed":{"post":{"summary":"call.failed","description":"An accepted call could not complete (a scheduled call that fails at fire-time, or a provider error). Synchronous rejections like DNC/hours come back on the POST /calls response instead. Not final. Agency `webhook_url` callbacks carry `data` exactly as in the example; partner subscriptions add the fields listed in `x-partner-data`.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Standard Webhooks message id (the event `id`, `evt_...`). Stable across retries: dedupe on it.","schema":{"type":"string","example":"evt_01J8XYZ"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when the delivery was signed. Reject if it is more than 300 seconds from your clock.","schema":{"type":"string","example":"1789063561"}},{"name":"webhook-signature","in":"header","required":true,"description":"One or more space-separated `v1,<base64 signature>` entries (several appear during secret rotation). Verify with a Standard Webhooks library first (Python: `Webhook(secret).verify(body, headers)` from `standardwebhooks`). To verify by hand: the HMAC-SHA256 key is the base64-decoded part of your `whsec_` signing secret after the prefix; sign `{webhook-id}.{webhook-timestamp}.{raw body bytes}` exactly, base64-encode the digest, and compare it in constant time against each `v1,` entry. Reject timestamps outside the 300 second window.","schema":{"type":"string","example":"v1,<base64 HMAC-SHA256 signature> (illustrative)"}}],"x-audience":"all","x-final":false,"requestBody":{"required":true,"content":{"application/json":{"example":{"id":"evt_01J8XYZ","type":"call.failed","created_at":"2026-09-10T18:06:01Z","api_version":"2026-09-10","data":{"call":{"id":"call_01J8","status":"failed","direction":"outbound","to_number":"+15555551234","from_number":"+15555550000","agent_id":"agent_01J8","disposition":null,"duration_seconds":73,"talk_time_seconds":58,"answered_at":"2026-09-10T18:05:10Z","ended_at":"2026-09-10T18:06:23Z","metadata":{"crm_id":"lead-42"}},"error":{"code":"SIP_ERROR","message":"upstream carrier rejected the call"}}}}}},"responses":{"200":{"description":"Acknowledge with any 2xx within ~5s and process asynchronously. Non-2xx or timeout is retried with exponential backoff (~5 attempts over a few hours)."}},"x-partner-data":{"call":{"id":"call_01J8","status":"failed","direction":"outbound","to_number":"+15555551234","from_number":"+15555550000","agent_id":"agent_01J8","disposition":null,"duration_seconds":73,"talk_time_seconds":58,"answered_at":"2026-09-10T18:05:10Z","ended_at":"2026-09-10T18:06:23Z","metadata":{"crm_id":"lead-42"}},"external_id":"crm-lead-42"}}}},"security":[{"ApiKeyAuth":[]}]}