Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.
Optional mapping of agent_id to snapshot_id or 'latest'. Keys must be agent IDs present in the campaign's agents array. Values are either ObjectId strings referencing agent snapshots, or 'latest' to auto-resolve the newest snapshot.
Phone numbers used by this campaign. Keyed by phone number. Using dict to ensure uniqueness. Stored also in phone_numbers and inbound_phone_numbers for backwards compatibility.
During the ringing phase (prolonged_ringing) - the tasks will be executed while the call is ringing.
Agent will pick up the call only after the tasks are completed.
Max duration is 10 seconds.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Eqho API","colors":{"primary":"#502fef","light":"#502fef","dark":"#502fef"},"favicon":"https://mintcdn.com/eqho/u4ffk1m_kvB69lIL/docs/favicon.svg?fit=max\u0026auto=format\u0026n=u4ffk1m_kvB69lIL\u0026q=85\u0026s=51f6652439d87b19a38ef415d0c4dd0e","logo":{"light":"https://mintcdn.com/eqho/u4ffk1m_kvB69lIL/docs/logo/light.svg?fit=max\u0026auto=format\u0026n=u4ffk1m_kvB69lIL\u0026q=85\u0026s=b9ce3b45ff5bb64ba3996856006b2ef7","dark":"https://mintcdn.com/eqho/u4ffk1m_kvB69lIL/docs/logo/dark.svg?fit=max\u0026auto=format\u0026n=u4ffk1m_kvB69lIL\u0026q=85\u0026s=bbac44d3af0c7bba78240496b65072e8","href":"https://eqho.ai"},"api":{"examples":{"languages":["bash","python","javascript","go"]},"mdx":{"server":["https://api.eqho.ai"],"auth":{"method":"key","name":"x-api-key"}}},"navbar":{"links":[{"label":"Support","href":"mailto:[email protected]"}],"primary":{"type":"button","label":"Go to app","href":"https://eqho.ai/login"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/eqho-ai"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"eqho","hasAudioNarration":false,"actualSubdomain":"eqho","customDomains":["docs.eqho.ai"],"gitSource":{"type":"github","owner":"echo-ignite","repo":"eqho-api","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aebb449aab3c78d313ecad9","collectionId":"7af4927b-c2ba-485d-b17b-a092efaec60e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aebb449aab3c78d313ecad9"},"feedback":{"thumbs":true,"issues":true,"edits":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aee375020ab8e4ffa05fd7c","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API References","count":103},{"language":"default","tag":"Endpoints","count":100},{"language":"default","tag":"Simulations","count":15},{"language":"default","tag":"Knowledge Base","count":10},{"language":"default","tag":"Leads","count":9},{"language":"default","tag":"Agents","count":8},{"language":"default","tag":"Actions","count":7},{"language":"default","tag":"Reports","count":7},{"language":"default","tag":"Campaigns","count":5},{"language":"default","tag":"Lead Lists","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"docs/api-reference/campaigns/get-campaign","slug":"/docs/api-reference/campaigns/get-campaign","pageMetadata":{"title":"Get Campaign By Id","openapi":"GET /v1/campaigns/{campaign_id}","description":null,"href":"/docs/api-reference/campaigns/get-campaign"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Campaign By Id","openapi":"GET /v1/campaigns/{campaign_id}","description":null,"href":"/docs/api-reference/campaigns/get-campaign"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["campaigns"],"summary":"Get Campaign","operationId":"get_campaign_v1_campaigns__campaign_id__get","security":["5cb8d4d8-3055-4e20-b47c-7fa254a21fb4","2682f291-2a4c-4538-a889-beb7c2e1dcec"],"parameters":["e46869d7-119d-4d59-aefc-ad5317b0d6e0"],"responses":{"200":"9f4cf7d3-fdf9-4a51-baf5-05e3c2cdb753","422":"0d782398-05c4-4cb1-90ce-d39cc092faf9"},"method":"get","type":"path","servers":[],"path":"/v1/campaigns/{campaign_id}","baseUrlOptions":["https://api.eqho.ai"],"title":"Get Campaign","description":"","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","go"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e46869d7-119d-4d59-aefc-ad5317b0d6e0":{"name":"campaign_id","in":"path","required":true,"schema":{"type":"string","maxLength":24,"minLength":24,"title":"Campaign Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"9f4cf7d3-fdf9-4a51-baf5-05e3c2cdb753":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"status":{"type":"string","enum":["CREATED","ACTIVE","INACTIVE","PAUSED","PROCESSED"],"title":"CampaignStatus","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"id":{"oneOf":[{"type":"string","title":"Id","uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Id","uniqueKey":"id.oneOf.1","typeLabel":"null"}],"uniqueKey":"id","typeLabel":"string | null"},"account_id":{"oneOf":[{"type":"string","title":"Account Id","uniqueKey":"account_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Account Id","uniqueKey":"account_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"account_id","typeLabel":"string | null"},"agents":{"items":{"type":"string","uniqueKey":"agents.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Agents","uniqueKey":"agents","typeLabel":"string[]"},"agent_snapshot_map":{"oneOf":[{"type":"object","title":"Agent Snapshot Map","description":"Optional mapping of agent_id to snapshot_id or '__latest__'. Keys must be agent IDs present in the campaign's agents array. Values are either ObjectId strings referencing agent snapshots, or '__latest__' to auto-resolve the newest snapshot.","additionalProperties":{"type":"string","uniqueKey":"agent_snapshot_map.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"agent_snapshot_map.oneOf.0","typeLabel":"Agent Snapshot Map · object"},{"type":"null","title":"Agent Snapshot Map","description":"Optional mapping of agent_id to snapshot_id or '__latest__'. Keys must be agent IDs present in the campaign's agents array. Values are either ObjectId strings referencing agent snapshots, or '__latest__' to auto-resolve the newest snapshot.","uniqueKey":"agent_snapshot_map.oneOf.1","typeLabel":"null"}],"uniqueKey":"agent_snapshot_map","typeLabel":"Agent Snapshot Map · object | null"},"distribution_strategy":{"type":"string","enum":["round_robin","custom_percentage","random"],"title":"DistributionStrategy","description":"How calls are distributed among agents in a campaign. ","default":"random","uniqueKey":"distribution_strategy","typeLabel":"enum\u003cstring>"},"distribution_settings":{"oneOf":[{"type":"object","title":"DistributionSettings","description":"Settings for the distribution strategy. Required for custom_percentage distribution strategy.","required":["percentages"],"properties":{"percentages":{"additionalProperties":{"type":"integer","uniqueKey":"distribution_settings.oneOf.0.percentages.additionalProperties","typeLabel":"integer"},"type":"object","title":"Percentages","description":"Mapping of agent_id to assigned percentage (integer values). This is used only for `custom_percentage` strategy.","isRequired":true,"uniqueKey":"distribution_settings.oneOf.0.percentages","typeLabel":"Percentages · object"},"last_assigned_agent_index":{"type":"integer","title":"Last Assigned Agent Index","description":"Index of the last assigned agent in the agents list. Used for round-robin distribution.","default":-1,"uniqueKey":"distribution_settings.oneOf.0.last_assigned_agent_index","typeLabel":"integer"}},"uniqueKey":"distribution_settings.oneOf.0","typeLabel":"DistributionSettings · object"},{"type":"null","description":"Settings for the distribution strategy. Required for custom_percentage distribution strategy.","uniqueKey":"distribution_settings.oneOf.1","typeLabel":"null"}],"uniqueKey":"distribution_settings","typeLabel":"DistributionSettings · object | null"},"distribution_by_medium":{"oneOf":[{"type":"object","title":"Distribution By Medium","description":"Per-medium agent pools and distribution; mediums without an entry use the default distribution.","additionalProperties":{"properties":{"agents":{"items":{"type":"string","uniqueKey":"distribution_by_medium.oneOf.0.additionalProperties.agents.items.[INDEX]","typeLabel":"string"},"type":"array","minItems":1,"title":"Agents","description":"Agent pool for this medium.","isRequired":true,"uniqueKey":"distribution_by_medium.oneOf.0.additionalProperties.agents","typeLabel":"string[]"},"distribution_strategy":{"type":"string","enum":["round_robin","custom_percentage","random"],"title":"DistributionStrategy","description":"How calls are distributed among agents in a campaign.","default":"random","uniqueKey":"distribution_by_medium.oneOf.0.additionalProperties.distribution_strategy","typeLabel":"enum\u003cstring>"},"distribution_settings":{"oneOf":[{"type":"object","title":"DistributionSettings","required":["percentages"],"properties":{"percentages":{"additionalProperties":{"type":"integer","uniqueKey":"distribution_by_medium.oneOf.0.additionalProperties.distribution_settings.oneOf.0.percentages.additionalProperties","typeLabel":"integer"},"type":"object","title":"Percentages","description":"Mapping of agent_id to assigned percentage (integer values). This is used only for `custom_percentage` strategy.","isRequired":true,"uniqueKey":"distribution_by_medium.oneOf.0.additionalProperties.distribution_settings.oneOf.0.percentages","typeLabel":"Percentages · object"},"last_assigned_agent_index":{"type":"integer","title":"Last Assigned Agent Index","description":"Index of the last assigned agent in the agents list. Used for round-robin distribution.","default":-1,"uniqueKey":"distribution_by_medium.oneOf.0.additionalProperties.distribution_settings.oneOf.0.last_assigned_agent_index","typeLabel":"integer"}},"uniqueKey":"distribution_by_medium.oneOf.0.additionalProperties.distribution_settings.oneOf.0","typeLabel":"DistributionSettings · object"},{"type":"null","uniqueKey":"distribution_by_medium.oneOf.0.additionalProperties.distribution_settings.oneOf.1","typeLabel":"null"}],"uniqueKey":"distribution_by_medium.oneOf.0.additionalProperties.distribution_settings","typeLabel":"DistributionSettings · object | null"}},"type":"object","required":["agents"],"title":"MediumDistribution","description":"Agent pool + distribution for one conversation medium. A medium without an\nentry falls back to the campaign's default agents/distribution.","uniqueKey":"distribution_by_medium.oneOf.0.additionalProperties","typeLabel":"MediumDistribution · object"},"uniqueKey":"distribution_by_medium.oneOf.0","typeLabel":"Distribution By Medium · object"},{"type":"null","title":"Distribution By Medium","description":"Per-medium agent pools and distribution; mediums without an entry use the default distribution.","uniqueKey":"distribution_by_medium.oneOf.1","typeLabel":"null"}],"uniqueKey":"distribution_by_medium","typeLabel":"Distribution By Medium · object | null"},"phone_numbers":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"phone_numbers.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Phone Numbers","uniqueKey":"phone_numbers.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Phone Numbers","uniqueKey":"phone_numbers.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone_numbers","typeLabel":"string[] | null"},"inbound_phone_numbers":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"inbound_phone_numbers.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Inbound Phone Numbers","uniqueKey":"inbound_phone_numbers.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Inbound Phone Numbers","uniqueKey":"inbound_phone_numbers.oneOf.1","typeLabel":"null"}],"uniqueKey":"inbound_phone_numbers","typeLabel":"string[] | null"},"claimed_phone_numbers":{"oneOf":[{"type":"object","title":"Claimed Phone Numbers","description":"Phone numbers used by this campaign. Keyed by phone number. Using dict to ensure uniqueness. Stored also in phone_numbers and inbound_phone_numbers for backwards compatibility.","additionalProperties":{"properties":{"phone_number":{"type":"string","format":"phone","title":"Phone Number","examples":["+14155551234"],"isRequired":true,"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.phone_number","typeLabel":"string\u003cphone>"},"provider_id":{"type":"string","title":"Provider Id","examples":["PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"],"isRequired":true,"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.provider_id","typeLabel":"string"},"campaign_configuration":{"properties":{"inbound_call_enabled":{"type":"boolean","title":"Inbound Call Enabled","description":"Whether the phone had been setup to receive inbound calls","default":false,"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.campaign_configuration.inbound_call_enabled","typeLabel":"boolean"},"outbound_call_enabled":{"type":"boolean","title":"Outbound Call Enabled","description":"Whether the phone had been setup to make outbound calls","default":false,"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.campaign_configuration.outbound_call_enabled","typeLabel":"boolean"}},"type":"object","title":"PhoneNumberCampaignConfiguration","description":"The configuration of a claimed phone number. A user can enable or disable inbound calls, outbound calls, and SMS.","isRequired":true,"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.campaign_configuration","typeLabel":"PhoneNumberCampaignConfiguration · object"},"_id":{"oneOf":[{"type":"string","title":"Id","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties._id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Id","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties._id.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties._id","typeLabel":"string | null"},"account_id":{"oneOf":[{"type":"string","title":"Account Id","description":"The account ID that owns this phone number","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.account_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Account Id","description":"The account ID that owns this phone number","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.account_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.account_id","typeLabel":"string | null"},"provider":{"oneOf":[{"type":"string","title":"PhoneNumberProviderEnum","description":"An enumeration of possible phone number providers.","default":"TWILIO","enum":["TWILIO","TELNYX","SIP"],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.provider.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","default":"TWILIO","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.provider","typeLabel":"enum\u003cstring> | null"},"region":{"oneOf":[{"type":"string","title":"Region","example":"NY","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.region.oneOf.0","typeLabel":"string"},{"type":"null","title":"Region","example":"NY","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.region.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.region","typeLabel":"string | null"},"country_code":{"oneOf":[{"type":"string","title":"Country Code","example":"US","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.country_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country Code","example":"US","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.country_code","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","title":"Type","example":"local","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","example":"local","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.type","typeLabel":"string | null"},"purchased_at":{"type":"string","format":"date-time","title":"Purchased At","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.purchased_at","typeLabel":"string\u003cdate-time>"},"sip_configuration":{"oneOf":[{"type":"object","title":"PhoneNumberSipConfiguration","description":"The configuration of a SIP phone number.","required":["sip_termination_url"],"properties":{"sip_termination_url":{"type":"string","title":"Sip Termination Url","isRequired":true,"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.sip_configuration.oneOf.0.sip_termination_url","typeLabel":"string"},"sip_username":{"oneOf":[{"type":"string","title":"Sip Username","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.sip_configuration.oneOf.0.sip_username.oneOf.0","typeLabel":"string"},{"type":"null","title":"Sip Username","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.sip_configuration.oneOf.0.sip_username.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.sip_configuration.oneOf.0.sip_username","typeLabel":"string | null"},"sip_password":{"oneOf":[{"type":"string","title":"Sip Password","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.sip_configuration.oneOf.0.sip_password.oneOf.0","typeLabel":"string"},{"type":"null","title":"Sip Password","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.sip_configuration.oneOf.0.sip_password.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.sip_configuration.oneOf.0.sip_password","typeLabel":"string | null"}},"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.sip_configuration.oneOf.0","typeLabel":"PhoneNumberSipConfiguration · object"},{"type":"null","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.sip_configuration.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.sip_configuration","typeLabel":"PhoneNumberSipConfiguration · object | null"},"gather_extension":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Whether to gather a keyed-in extension on inbound calls","default":false,"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.gather_extension.enabled","typeLabel":"boolean"},"prompt":{"oneOf":[{"type":"string","title":"Prompt","description":"Optional spoken prompt. Leave empty for a silent gather (auto-DTMF use case).","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.gather_extension.prompt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Prompt","description":"Optional spoken prompt. Leave empty for a silent gather (auto-DTMF use case).","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.gather_extension.prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.gather_extension.prompt","typeLabel":"string | null"},"timeout_seconds":{"type":"integer","title":"Timeout Seconds","description":"Seconds to wait for DTMF input before falling through","default":5,"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.gather_extension.timeout_seconds","typeLabel":"integer"},"num_digits":{"oneOf":[{"type":"integer","title":"Num Digits","description":"Auto-submit after N digits. None = variable length terminated by finish_on_key.","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.gather_extension.num_digits.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Num Digits","description":"Auto-submit after N digits. None = variable length terminated by finish_on_key.","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.gather_extension.num_digits.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.gather_extension.num_digits","typeLabel":"integer | null"},"finish_on_key":{"type":"string","title":"Finish On Key","description":"Key that ends variable-length digit collection","default":"#","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.gather_extension.finish_on_key","typeLabel":"string"}},"type":"object","title":"GatherExtensionConfiguration","description":"Config for capturing a keyed-in extension (DTMF) on inbound calls to this number.\n\nIntended for calls forwarded from an upstream PBX (e.g. RingCentral) that auto-sends\nthe extension after answer. Leave `prompt` empty for a silent gather so a human caller\nforwarded through isn't confused by an \"enter your extension\" message.","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.gather_extension","typeLabel":"GatherExtensionConfiguration · object"},"inbound_routing":{"properties":{"mode":{"type":"string","enum":["ai_agent","softphone","ivr","seat"],"title":"InboundRoutingMode","default":"ai_agent","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.inbound_routing.mode","typeLabel":"enum\u003cstring>"},"ivr_flow_id":{"oneOf":[{"type":"string","title":"Ivr Flow Id","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.inbound_routing.ivr_flow_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Ivr Flow Id","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.inbound_routing.ivr_flow_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.inbound_routing.ivr_flow_id","typeLabel":"string | null"},"ring_group":{"items":{"type":"string","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.inbound_routing.ring_group.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Ring Group","description":"Seat ids to ring for softphone mode","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.inbound_routing.ring_group","typeLabel":"string[]"},"seat_id":{"oneOf":[{"type":"string","title":"Seat Id","description":"Owning seat id for seat (personal number) mode","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.inbound_routing.seat_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Seat Id","description":"Owning seat id for seat (personal number) mode","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.inbound_routing.seat_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.inbound_routing.seat_id","typeLabel":"string | null"}},"type":"object","title":"InboundRouting","description":"How inbound PSTN calls to this number are handled.\n\n- ai_agent: default — dispatched to the voice-engine-v3 agent (existing behavior).\n- softphone: ring the seats in `ring_group` (human-in-browser).\n- ivr: run `ivr_flow_id` (unified IVR runtime), which may itself route to seats/agents/etc.\n- seat: the number is a seat's personal number — ring exactly `seat_id`.","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.inbound_routing","typeLabel":"InboundRouting · object"},"softphone_outbound_enabled":{"type":"boolean","title":"Softphone Outbound Enabled","description":"Company softphone number: usable as an outbound caller-ID from any softphone seat, independent of how inbound calls to it are routed","default":false,"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.softphone_outbound_enabled","typeLabel":"boolean"},"sip_enabled_at":{"oneOf":[{"type":"string","title":"Sip Enabled At","description":"When this phone number was successfully enabled for SIP routing.","format":"date-time","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.sip_enabled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Sip Enabled At","description":"When this phone number was successfully enabled for SIP routing.","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.sip_enabled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.sip_enabled_at","typeLabel":"string\u003cdate-time> | null"},"associated_campaigns":{"items":{"type":"string","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.associated_campaigns.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Associated Campaigns","description":"List of campaign IDs that use this phone number","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.associated_campaigns","typeLabel":"string[]"},"is_active":{"type":"boolean","title":"Is Active","description":"Whether the phone number is currently active","default":true,"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.is_active","typeLabel":"boolean"},"released_at":{"oneOf":[{"type":"string","title":"Released At","description":"When the phone number was released","format":"date-time","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.released_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Released At","description":"When the phone number was released","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.released_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.released_at","typeLabel":"string\u003cdate-time> | null"},"released_by":{"oneOf":[{"type":"string","title":"Released By","description":"User who released the phone number","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.released_by.oneOf.0","typeLabel":"string"},{"type":"null","title":"Released By","description":"User who released the phone number","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.released_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties.released_by","typeLabel":"string | null"}},"type":"object","required":["phone_number","provider_id","campaign_configuration"],"title":"ClaimedPhoneNumber","description":"A phone number that has been purchased from a provider (e.g. Twilio) and configured for use.","uniqueKey":"claimed_phone_numbers.oneOf.0.additionalProperties","typeLabel":"ClaimedPhoneNumber · object"},"uniqueKey":"claimed_phone_numbers.oneOf.0","typeLabel":"Claimed Phone Numbers · object"},{"type":"null","title":"Claimed Phone Numbers","description":"Phone numbers used by this campaign. Keyed by phone number. Using dict to ensure uniqueness. Stored also in phone_numbers and inbound_phone_numbers for backwards compatibility.","uniqueKey":"claimed_phone_numbers.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_phone_numbers","typeLabel":"Claimed Phone Numbers · object | null"},"dispositions":{"items":{"properties":{"id":{"type":"string","title":"Id","isRequired":true,"uniqueKey":"dispositions.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"dispositions.items.[INDEX].name","typeLabel":"string"},"parent_disposition":{"type":"string","title":"Parent Disposition","isRequired":true,"uniqueKey":"dispositions.items.[INDEX].parent_disposition","typeLabel":"string"},"description":{"oneOf":[{"type":"string","title":"Description","uniqueKey":"dispositions.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","uniqueKey":"dispositions.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"dispositions.items.[INDEX].description","typeLabel":"string | null"},"color":{"oneOf":[{"type":"string","title":"Color","default":"#A5A5A5","uniqueKey":"dispositions.items.[INDEX].color.oneOf.0","typeLabel":"string"},{"type":"null","title":"Color","default":"#A5A5A5","uniqueKey":"dispositions.items.[INDEX].color.oneOf.1","typeLabel":"null"}],"uniqueKey":"dispositions.items.[INDEX].color","typeLabel":"string | null"},"contacted":{"oneOf":[{"type":"boolean","title":"Contacted","default":true,"uniqueKey":"dispositions.items.[INDEX].contacted.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Contacted","default":true,"uniqueKey":"dispositions.items.[INDEX].contacted.oneOf.1","typeLabel":"null"}],"uniqueKey":"dispositions.items.[INDEX].contacted","typeLabel":"boolean | null"},"conversion":{"oneOf":[{"type":"boolean","title":"Conversion","default":true,"uniqueKey":"dispositions.items.[INDEX].conversion.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Conversion","default":true,"uniqueKey":"dispositions.items.[INDEX].conversion.oneOf.1","typeLabel":"null"}],"uniqueKey":"dispositions.items.[INDEX].conversion","typeLabel":"boolean | null"},"blocklist_level":{"oneOf":[{"type":"string","title":"BlocklistLevel","enum":["CAMPAIGN","ORGANIZATION"],"uniqueKey":"dispositions.items.[INDEX].blocklist_level.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"dispositions.items.[INDEX].blocklist_level.oneOf.1","typeLabel":"null"}],"uniqueKey":"dispositions.items.[INDEX].blocklist_level","typeLabel":"enum\u003cstring> | null"},"enabled":{"type":"boolean","title":"Enabled","default":true,"uniqueKey":"dispositions.items.[INDEX].enabled","typeLabel":"boolean"}},"type":"object","required":["id","name","parent_disposition"],"title":"DispositionModel","uniqueKey":"dispositions.items.[INDEX]","typeLabel":"DispositionModel · object"},"type":"array","title":"Dispositions","uniqueKey":"dispositions","typeLabel":"DispositionModel · object[]"},"disposition_instructions":{"oneOf":[{"type":"string","title":"Disposition Instructions","description":"scheduled for removal","deprecated":true,"uniqueKey":"disposition_instructions.oneOf.0","typeLabel":"string"},{"type":"null","title":"Disposition Instructions","description":"scheduled for removal","deprecated":true,"uniqueKey":"disposition_instructions.oneOf.1","typeLabel":"null"}],"uniqueKey":"disposition_instructions","typeLabel":"string | null"},"disposition_level_2_instructions":{"oneOf":[{"type":"string","title":"Disposition Level 2 Instructions","description":"scheduled for removal","deprecated":true,"uniqueKey":"disposition_level_2_instructions.oneOf.0","typeLabel":"string"},{"type":"null","title":"Disposition Level 2 Instructions","description":"scheduled for removal","deprecated":true,"uniqueKey":"disposition_level_2_instructions.oneOf.1","typeLabel":"null"}],"uniqueKey":"disposition_level_2_instructions","typeLabel":"string | null"},"disposition_level_3_prompt":{"oneOf":[{"type":"string","title":"Disposition Level 3 Prompt","description":"Custom prompt to classify call outcome. If not provided, a default prompt will be used.","uniqueKey":"disposition_level_3_prompt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Disposition Level 3 Prompt","description":"Custom prompt to classify call outcome. If not provided, a default prompt will be used.","uniqueKey":"disposition_level_3_prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"disposition_level_3_prompt","typeLabel":"string | null"},"call_summary_description":{"oneOf":[{"type":"string","title":"Call Summary Description","description":"Instructions for this campaign's call summary. Blank uses the system default.","uniqueKey":"call_summary_description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Call Summary Description","description":"Instructions for this campaign's call summary. Blank uses the system default.","uniqueKey":"call_summary_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_summary_description","typeLabel":"string | null"},"disposition_level_3_reasoning":{"oneOf":[{"type":"string","title":"Disposition Level 3 Reasoning","description":"Reasoning effort for disposition classification and its call summary. Null inherits the agent's reasoning setting, then the system default.","enum":["none","low","medium","high"],"uniqueKey":"disposition_level_3_reasoning.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Disposition Level 3 Reasoning","description":"Reasoning effort for disposition classification and its call summary. Null inherits the agent's reasoning setting, then the system default.","uniqueKey":"disposition_level_3_reasoning.oneOf.1","typeLabel":"null"}],"uniqueKey":"disposition_level_3_reasoning","typeLabel":"enum\u003cstring> | null"},"disposition_level_3_model":{"oneOf":[{"type":"string","title":"Disposition Level 3 Model","description":"Model to use for disposition level 3 classification. If not provided, the default model will be used.","enum":["gpt-5.4","gpt-5.4-pro","gpt-5.2","gpt-5.2-pro","gpt-5.1","gpt-5","gpt-5-pro","gpt-5-mini","gpt-5-nano","gpt-4.1","gpt-4.1-mini","gpt-4.1-nano","gpt-4o","gpt-4o-mini","o3","o3-pro","o3-mini","o4-mini","claude-opus-4-6-20260205","claude-sonnet-4-6-20260205","claude-opus-4-5-20251101","claude-sonnet-4-5-20250929","claude-haiku-4-5-20251001","claude-opus-4-20250514","claude-sonnet-4-20250514","gemini-3.1-pro-preview","gemini-3-flash-preview","gemini-2.5-pro","deepseek-chat","deepseek-reasoner","gpt-5-chat-latest","gpt-5.1-chat-latest","gpt-5.2-chat-latest","gpt-5.3-chat-latest"],"uniqueKey":"disposition_level_3_model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Disposition Level 3 Model","description":"Model to use for disposition level 3 classification. If not provided, the default model will be used.","uniqueKey":"disposition_level_3_model.oneOf.1","typeLabel":"string"},{"type":"null","title":"Disposition Level 3 Model","description":"Model to use for disposition level 3 classification. If not provided, the default model will be used.","uniqueKey":"disposition_level_3_model.oneOf.2","typeLabel":"null"}],"uniqueKey":"disposition_level_3_model","typeLabel":"enum\u003cstring> | string | null"},"rules":{"oneOf":[{"type":"object","title":"Rules","required":["call_limit","call_window"],"properties":{"call_limit":{"type":"integer","title":"Call Limit","isRequired":true,"uniqueKey":"rules.oneOf.0.call_limit","typeLabel":"integer"},"call_window":{"items":{"properties":{"weekday":{"type":"integer","exclusiveMaximum":7,"minimum":0,"title":"Weekday","isRequired":true,"uniqueKey":"rules.oneOf.0.call_window.items.[INDEX].weekday","typeLabel":"integer"},"start_time":{"type":"integer","maximum":2359,"minimum":0,"title":"Start Time","isRequired":true,"uniqueKey":"rules.oneOf.0.call_window.items.[INDEX].start_time","typeLabel":"integer"},"end_time":{"type":"integer","maximum":2359,"minimum":0,"title":"End Time","isRequired":true,"uniqueKey":"rules.oneOf.0.call_window.items.[INDEX].end_time","typeLabel":"integer"}},"type":"object","required":["weekday","start_time","end_time"],"title":"IntervalModel","uniqueKey":"rules.oneOf.0.call_window.items.[INDEX]","typeLabel":"IntervalModel · object"},"type":"array","title":"Call Window","isRequired":true,"uniqueKey":"rules.oneOf.0.call_window","typeLabel":"IntervalModel · object[]"},"messenger_disposition_threshold_in_minutes":{"oneOf":[{"type":"integer","title":"Messenger Disposition Threshold In Minutes","uniqueKey":"rules.oneOf.0.messenger_disposition_threshold_in_minutes.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Messenger Disposition Threshold In Minutes","uniqueKey":"rules.oneOf.0.messenger_disposition_threshold_in_minutes.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.oneOf.0.messenger_disposition_threshold_in_minutes","typeLabel":"integer | null"},"medium_response_settings":{"oneOf":[{"type":"object","title":"Medium Response Settings","additionalProperties":{"properties":{"min_delay_words_per_second":{"oneOf":[{"type":"number","title":"Min Delay Words Per Second","uniqueKey":"rules.oneOf.0.medium_response_settings.oneOf.0.additionalProperties.min_delay_words_per_second.oneOf.0","typeLabel":"number"},{"type":"null","title":"Min Delay Words Per Second","uniqueKey":"rules.oneOf.0.medium_response_settings.oneOf.0.additionalProperties.min_delay_words_per_second.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.oneOf.0.medium_response_settings.oneOf.0.additionalProperties.min_delay_words_per_second","typeLabel":"number | null"},"min_delay_seconds":{"oneOf":[{"type":"number","title":"Min Delay Seconds","uniqueKey":"rules.oneOf.0.medium_response_settings.oneOf.0.additionalProperties.min_delay_seconds.oneOf.0","typeLabel":"number"},{"type":"null","title":"Min Delay Seconds","uniqueKey":"rules.oneOf.0.medium_response_settings.oneOf.0.additionalProperties.min_delay_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.oneOf.0.medium_response_settings.oneOf.0.additionalProperties.min_delay_seconds","typeLabel":"number | null"}},"type":"object","title":"MediumResponseSettings","uniqueKey":"rules.oneOf.0.medium_response_settings.oneOf.0.additionalProperties","typeLabel":"MediumResponseSettings · object"},"uniqueKey":"rules.oneOf.0.medium_response_settings.oneOf.0","typeLabel":"Medium Response Settings · object"},{"type":"null","title":"Medium Response Settings","uniqueKey":"rules.oneOf.0.medium_response_settings.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.oneOf.0.medium_response_settings","typeLabel":"Medium Response Settings · object | null"},"api_text_disposition_threshold_in_minutes":{"oneOf":[{"type":"integer","title":"Api Text Disposition Threshold In Minutes","uniqueKey":"rules.oneOf.0.api_text_disposition_threshold_in_minutes.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Api Text Disposition Threshold In Minutes","uniqueKey":"rules.oneOf.0.api_text_disposition_threshold_in_minutes.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.oneOf.0.api_text_disposition_threshold_in_minutes","typeLabel":"integer | null"},"should_answer_policy":{"oneOf":[{"type":"object","title":"ShouldAnswerPolicySettings","properties":{"enabled":{"type":"boolean","title":"Enabled","default":false,"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.enabled","typeLabel":"boolean"},"mode":{"type":"string","enum":["off","suppress_only","rewrite_only","rewrite_or_suppress","shadow"],"title":"ShouldAnswerPolicyMode","default":"suppress_only","uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"enabled_mediums":{"items":{"type":"string","enum":["web_voice","telephony","sms","email","chatbot","api_text","chat_app","softphone"],"title":"ConversationMediumType","uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.enabled_mediums.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","title":"Enabled Mediums","uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.enabled_mediums","typeLabel":"enum\u003cstring>[]"},"exact_match_enabled":{"type":"boolean","title":"Exact Match Enabled","default":true,"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.exact_match_enabled","typeLabel":"boolean"},"jaccard_enabled":{"type":"boolean","title":"Jaccard Enabled","default":true,"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.jaccard_enabled","typeLabel":"boolean"},"suppress_threshold":{"type":"number","maximum":1,"minimum":0,"title":"Suppress Threshold","default":0.85,"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.suppress_threshold","typeLabel":"number"},"fuzzy_threshold":{"type":"number","maximum":1,"minimum":0,"title":"Fuzzy Threshold","default":0.5,"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.fuzzy_threshold","typeLabel":"number"},"llm_judge_enabled":{"type":"boolean","title":"Llm Judge Enabled","default":false,"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.llm_judge_enabled","typeLabel":"boolean"},"llm_judge_always":{"type":"boolean","title":"Llm Judge Always","default":false,"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.llm_judge_always","typeLabel":"boolean"},"llm_judge_action":{"type":"string","enum":["rewrite","suppress"],"title":"LLMJudgeAction","description":"What to do when the advisory LLM judge flags a soft duplicate.\n\nThe programmatic tier (exact match + Jaccard) ALWAYS suppresses on hit.\nThe LLM judge is an advisory signal for the soft cases below the\nprogrammatic suppress_threshold.","default":"rewrite","uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.llm_judge_action","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","title":"Model","enum":["gpt-5.4","gpt-5.4-pro","gpt-5.2","gpt-5.2-pro","gpt-5.1","gpt-5","gpt-5-pro","gpt-5-mini","gpt-5-nano","gpt-4.1","gpt-4.1-mini","gpt-4.1-nano","gpt-4o","gpt-4o-mini","o3","o3-pro","o3-mini","o4-mini","claude-opus-4-6-20260205","claude-sonnet-4-6-20260205","claude-opus-4-5-20251101","claude-sonnet-4-5-20250929","claude-haiku-4-5-20251001","claude-opus-4-20250514","claude-sonnet-4-20250514","gemini-3.1-pro-preview","gemini-3-flash-preview","gemini-2.5-pro","deepseek-chat","deepseek-reasoner","gpt-5-chat-latest","gpt-5.1-chat-latest","gpt-5.2-chat-latest","gpt-5.3-chat-latest"],"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Model","uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.model.oneOf.1","typeLabel":"string"},{"type":"null","title":"Model","uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.model.oneOf.2","typeLabel":"null"}],"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.model","typeLabel":"enum\u003cstring> | string | null"},"timeout_seconds":{"type":"integer","maximum":120,"minimum":1,"title":"Timeout Seconds","default":10,"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.timeout_seconds","typeLabel":"integer"},"num_retries":{"type":"integer","maximum":5,"minimum":0,"title":"Num Retries","default":1,"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.num_retries","typeLabel":"integer"},"max_consecutive_suppressions":{"type":"integer","maximum":10,"minimum":0,"title":"Max Consecutive Suppressions","default":2,"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.max_consecutive_suppressions","typeLabel":"integer"},"on_suppression_limit_reached":{"type":"string","enum":["force_send","force_rewrite_send"],"title":"SuppressionLimitBehavior","default":"force_send","uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.on_suppression_limit_reached","typeLabel":"enum\u003cstring>"},"suppression_history_enabled":{"type":"boolean","title":"Suppression History Enabled","default":true,"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.suppression_history_enabled","typeLabel":"boolean"},"suppression_history_max_size":{"type":"integer","maximum":100,"minimum":1,"title":"Suppression History Max Size","default":10,"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.suppression_history_max_size","typeLabel":"integer"},"llm_judge_prompt_markdown":{"oneOf":[{"type":"string","title":"Llm Judge Prompt Markdown","uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.llm_judge_prompt_markdown.oneOf.0","typeLabel":"string"},{"type":"null","title":"Llm Judge Prompt Markdown","uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.llm_judge_prompt_markdown.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.llm_judge_prompt_markdown","typeLabel":"string | null"},"llm_rewrite_prompt_markdown":{"oneOf":[{"type":"string","title":"Llm Rewrite Prompt Markdown","uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.llm_rewrite_prompt_markdown.oneOf.0","typeLabel":"string"},{"type":"null","title":"Llm Rewrite Prompt Markdown","uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.llm_rewrite_prompt_markdown.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0.llm_rewrite_prompt_markdown","typeLabel":"string | null"}},"uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.0","typeLabel":"ShouldAnswerPolicySettings · object"},{"type":"null","uniqueKey":"rules.oneOf.0.should_answer_policy.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.oneOf.0.should_answer_policy","typeLabel":"ShouldAnswerPolicySettings · object | null"},"message_reaction_policy":{"oneOf":[{"type":"object","title":"MessageReactionPolicySettings","required":["action"],"properties":{"action":{"type":"string","enum":["completely_ignore","suppress_response_but_record_reaction","pass_as_tool_call_and_respond"],"title":"MessageReactionAction","isRequired":true,"uniqueKey":"rules.oneOf.0.message_reaction_policy.oneOf.0.action","typeLabel":"enum\u003cstring>"},"enabled_mediums":{"items":{"type":"string","enum":["web_voice","telephony","sms","email","chatbot","api_text","chat_app","softphone"],"title":"ConversationMediumType","uniqueKey":"rules.oneOf.0.message_reaction_policy.oneOf.0.enabled_mediums.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","title":"Enabled Mediums","uniqueKey":"rules.oneOf.0.message_reaction_policy.oneOf.0.enabled_mediums","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"rules.oneOf.0.message_reaction_policy.oneOf.0","typeLabel":"MessageReactionPolicySettings · object"},{"type":"null","uniqueKey":"rules.oneOf.0.message_reaction_policy.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.oneOf.0.message_reaction_policy","typeLabel":"MessageReactionPolicySettings · object | null"},"session_timeout":{"oneOf":[{"type":"object","title":"SessionTimeout","description":"How long a conversation stays open for reuse, counted from its last activity. Applies to every conversation medium. Omit (or send null) for conversations that never expire; that is the default. Separate from the disposition thresholds above, which are unaffected by this setting. Components are summed and stored canonically, so {'hours': 36} is returned as {'days': 1, 'hours': 12, 'minutes': 0}. Constraints not expressible in this schema: the summed window must be greater than zero (an all-zero or empty object is rejected with 422 -- omit the field instead) and must not exceed 3650 days in total.","properties":{"days":{"type":"integer","maximum":3650,"minimum":0,"title":"Days","default":0,"uniqueKey":"rules.oneOf.0.session_timeout.oneOf.0.days","typeLabel":"integer"},"hours":{"type":"integer","minimum":0,"title":"Hours","default":0,"uniqueKey":"rules.oneOf.0.session_timeout.oneOf.0.hours","typeLabel":"integer"},"minutes":{"type":"integer","minimum":0,"title":"Minutes","default":0,"uniqueKey":"rules.oneOf.0.session_timeout.oneOf.0.minutes","typeLabel":"integer"}},"uniqueKey":"rules.oneOf.0.session_timeout.oneOf.0","typeLabel":"SessionTimeout · object"},{"type":"null","description":"How long a conversation stays open for reuse, counted from its last activity. Applies to every conversation medium. Omit (or send null) for conversations that never expire; that is the default. Separate from the disposition thresholds above, which are unaffected by this setting. Components are summed and stored canonically, so {'hours': 36} is returned as {'days': 1, 'hours': 12, 'minutes': 0}. Constraints not expressible in this schema: the summed window must be greater than zero (an all-zero or empty object is rejected with 422 -- omit the field instead) and must not exceed 3650 days in total.","uniqueKey":"rules.oneOf.0.session_timeout.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.oneOf.0.session_timeout","typeLabel":"SessionTimeout · object | null"},"llm_fallback":{"oneOf":[{"type":"object","title":"Llm Fallback","description":"Where eqho-ai sends this campaign's conversations when OpenAI cannot answer. Each key overrides eqho-ai's default, which is {\"same_model\": true, \"cross_family\": false}; omit a key, the object or send null to keep the default. same_model: the same OpenAI model through Vercel AI Gateway, served from Azure or Bedrock. cross_family: then Claude, then Gemini, through Vercel AI Gateway. Applies to API text, SMS, chat and voice conversations; has no effect until the platform's Vercel AI Gateway key is configured.","example":{"cross_family":true},"additionalProperties":{"type":"boolean","uniqueKey":"rules.oneOf.0.llm_fallback.oneOf.0.additionalProperties","typeLabel":"boolean"},"uniqueKey":"rules.oneOf.0.llm_fallback.oneOf.0","typeLabel":"Llm Fallback · object"},{"type":"null","title":"Llm Fallback","description":"Where eqho-ai sends this campaign's conversations when OpenAI cannot answer. Each key overrides eqho-ai's default, which is {\"same_model\": true, \"cross_family\": false}; omit a key, the object or send null to keep the default. same_model: the same OpenAI model through Vercel AI Gateway, served from Azure or Bedrock. cross_family: then Claude, then Gemini, through Vercel AI Gateway. Applies to API text, SMS, chat and voice conversations; has no effect until the platform's Vercel AI Gateway key is configured.","example":{"cross_family":true},"uniqueKey":"rules.oneOf.0.llm_fallback.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.oneOf.0.llm_fallback","typeLabel":"Llm Fallback · object | null"}},"uniqueKey":"rules.oneOf.0","typeLabel":"Rules · object"},{"type":"null","uniqueKey":"rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules","typeLabel":"Rules · object | null"},"enabled":{"oneOf":[{"type":"boolean","title":"Enabled","default":true,"uniqueKey":"enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Enabled","default":true,"uniqueKey":"enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"enabled","typeLabel":"boolean | null"},"history":{"oneOf":[{"type":"object","title":"HistoryModel","required":["last_modified_at"],"properties":{"last_modified_at":{"type":"string","format":"date-time","title":"Last Modified At","isRequired":true,"uniqueKey":"history.oneOf.0.last_modified_at","typeLabel":"string\u003cdate-time>"},"revision":{"type":"integer","title":"Revision","default":0,"uniqueKey":"history.oneOf.0.revision","typeLabel":"integer"},"created_at":{"oneOf":[{"type":"string","title":"Created At","format":"date-time","uniqueKey":"history.oneOf.0.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At","uniqueKey":"history.oneOf.0.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"history.oneOf.0.created_at","typeLabel":"string\u003cdate-time> | null"},"created_by":{"type":"string","title":"Created By","default":"unknown","uniqueKey":"history.oneOf.0.created_by","typeLabel":"string"},"last_modified_by":{"type":"string","title":"Last Modified By","default":"unknown","uniqueKey":"history.oneOf.0.last_modified_by","typeLabel":"string"}},"uniqueKey":"history.oneOf.0","typeLabel":"HistoryModel · object"},{"type":"null","uniqueKey":"history.oneOf.1","typeLabel":"null"}],"uniqueKey":"history","typeLabel":"HistoryModel · object | null"},"tasks":{"items":{"properties":{"task_type":{"type":"string","enum":["try_again","webhook","text","call_forward","email","http_request","llm_call","update_lead"],"title":"CallTaskType","description":"Use `webhook` instead.","isRequired":true,"uniqueKey":"tasks.items.[INDEX].task_type","typeLabel":"enum\u003cstring>"},"task_settings":{"additionalProperties":true,"type":"object","title":"Task Settings","isRequired":true,"uniqueKey":"tasks.items.[INDEX].task_settings","typeLabel":"Task Settings · object"},"id":{"type":"string","title":"Id","uniqueKey":"tasks.items.[INDEX].id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"tasks.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"tasks.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"tasks.items.[INDEX].name","typeLabel":"string | null"},"type":{"type":"string","enum":["pre_call","post_call"],"title":"CallTaskExecutionPhase","description":"CallTasks can be executed before or after a call.","default":"post_call","uniqueKey":"tasks.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"condition":{"oneOf":[{"type":"object","title":"CallTaskCondition","properties":{"call_count":{"items":{"type":"integer","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.call_count.items.[INDEX]","typeLabel":"integer"},"type":"array","title":"Call Count","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.call_count","typeLabel":"integer[]"},"dispositions":{"items":{"properties":{"field":{"type":"string","enum":["twilio_status","disposition_level_2","disposition_level_3"],"title":"Field","isRequired":true,"uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.dispositions.items.[INDEX].field","typeLabel":"enum\u003cstring>"},"values":{"items":{"type":"string","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.dispositions.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Values","isRequired":true,"uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.dispositions.items.[INDEX].values","typeLabel":"string[]"}},"type":"object","required":["field","values"],"title":"CallTaskDispositionCondition","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.dispositions.items.[INDEX]","typeLabel":"CallTaskDispositionCondition · object"},"type":"array","title":"Dispositions","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.dispositions","typeLabel":"CallTaskDispositionCondition · object[]"},"ai_conditions":{"items":{"properties":{"condition":{"type":"string","title":"Condition","description":"Yes or no condition about the conversation to evaluate the call transcript with LLM","examples":["Did the lead say there is a child in the car?","Did the lead say they like to recieve marketing emails?"],"isRequired":true,"uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.ai_conditions.items.[INDEX].condition","typeLabel":"string"},"confidence_threshold":{"oneOf":[{"type":"number","title":"Confidence Threshold","description":"Add a required LLM confidence threshold to execute the task","maximum":1,"minimum":0,"exclusiveMaximum":true,"uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.ai_conditions.items.[INDEX].confidence_threshold.oneOf.0","typeLabel":"number"},{"type":"null","title":"Confidence Threshold","description":"Add a required LLM confidence threshold to execute the task","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.ai_conditions.items.[INDEX].confidence_threshold.oneOf.1","typeLabel":"null"}],"uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.ai_conditions.items.[INDEX].confidence_threshold","typeLabel":"number | null"}},"type":"object","required":["condition"],"title":"CallTaskAiCondition","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.ai_conditions.items.[INDEX]","typeLabel":"CallTaskAiCondition · object"},"type":"array","title":"Ai Conditions","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.ai_conditions","typeLabel":"CallTaskAiCondition · object[]"},"eval_conditions":{"items":{"properties":{"grader_name":{"type":"string","title":"Grader Name","description":"The grader name to match against eval results.","isRequired":true,"uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.eval_conditions.items.[INDEX].grader_name","typeLabel":"string"},"values":{"items":{"oneOf":[{"type":"string","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.eval_conditions.items.[INDEX].values.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.eval_conditions.items.[INDEX].values.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.eval_conditions.items.[INDEX].values.items.[INDEX]","typeLabel":"string | number"},"type":"array","title":"Values","description":"If non-empty, the grader result must be one of these values.","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.eval_conditions.items.[INDEX].values","typeLabel":"(string | number)[]"},"passed":{"oneOf":[{"type":"boolean","title":"Passed","description":"If set, the grader result's passed flag must match this value.","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.eval_conditions.items.[INDEX].passed.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Passed","description":"If set, the grader result's passed flag must match this value.","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.eval_conditions.items.[INDEX].passed.oneOf.1","typeLabel":"null"}],"uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.eval_conditions.items.[INDEX].passed","typeLabel":"boolean | null"}},"type":"object","required":["grader_name"],"title":"CallTaskEvalCondition","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.eval_conditions.items.[INDEX]","typeLabel":"CallTaskEvalCondition · object"},"type":"array","title":"Eval Conditions","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.eval_conditions","typeLabel":"CallTaskEvalCondition · object[]"},"expression_conditions":{"items":{"properties":{"expression":{"type":"string","title":"Expression","description":"A Jinja expression evaluated against the call's template context. The condition is met when it evaluates truthy. Written bare: {{ }}, {% %} and {# #} are template syntax, not expression syntax, and are rejected. Compiled as an expression rather than rendered, so values keep their real types -- 0, [] and a missing path are falsy, and the and/or/not/in operators and comparisons all work.","examples":["conversation.action_runs.call_transfer.last.success","conversation.action_runs.lookup_tow_status.count > 0"],"isRequired":true,"uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.expression_conditions.items.[INDEX].expression","typeLabel":"string"}},"type":"object","required":["expression"],"title":"CallTaskExpressionCondition","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.expression_conditions.items.[INDEX]","typeLabel":"CallTaskExpressionCondition · object"},"type":"array","title":"Expression Conditions","uniqueKey":"tasks.items.[INDEX].condition.oneOf.0.expression_conditions","typeLabel":"CallTaskExpressionCondition · object[]"}},"uniqueKey":"tasks.items.[INDEX].condition.oneOf.0","typeLabel":"CallTaskCondition · object"},{"type":"null","uniqueKey":"tasks.items.[INDEX].condition.oneOf.1","typeLabel":"null"}],"uniqueKey":"tasks.items.[INDEX].condition","typeLabel":"CallTaskCondition · object | null"},"required":{"type":"boolean","title":"Required","description":"If true, failure of this task prevents the call from being made. Currently supported for 'Webhook'","default":false,"uniqueKey":"tasks.items.[INDEX].required","typeLabel":"boolean"},"enabled":{"type":"boolean","title":"Enabled","default":true,"uniqueKey":"tasks.items.[INDEX].enabled","typeLabel":"boolean"}},"type":"object","required":["task_type","task_settings"],"title":"CallTask","description":"CallTask allows you to do some processing before and/or after a call.\nIt can be used to retry a call, send a webhook, send a text message, etc.\nYou can also set conditions to execute the task based on the call count or disposition.","uniqueKey":"tasks.items.[INDEX]","typeLabel":"CallTask · object"},"type":"array","title":"Tasks","uniqueKey":"tasks","typeLabel":"CallTask · object[]"},"call_now_threshold_recall_time":{"oneOf":[{"type":"integer","title":"Call Now Threshold Recall Time","uniqueKey":"call_now_threshold_recall_time.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Call Now Threshold Recall Time","uniqueKey":"call_now_threshold_recall_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_now_threshold_recall_time","typeLabel":"integer | null"},"external_context_template":{"oneOf":[{"type":"string","title":"External Context Template","uniqueKey":"external_context_template.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Context Template","uniqueKey":"external_context_template.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_context_template","typeLabel":"string | null"},"system_prompt":{"oneOf":[{"type":"object","title":"EmbeddedSystemPromptModel","properties":{"inbound":{"oneOf":[{"type":"object","title":"EmbeddedSystemPromptSubModel","required":["sections","medium"],"properties":{"sections":{"items":{"properties":{"title":{"type":"string","title":"Title","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.sections.items.[INDEX].title","typeLabel":"string"},"description":{"type":"string","title":"Description","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.sections.items.[INDEX].description","typeLabel":"string"}},"type":"object","required":["title","description"],"title":"SystemPromptSection","uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.sections.items.[INDEX]","typeLabel":"SystemPromptSection · object"},"type":"array","title":"Sections","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.sections","typeLabel":"SystemPromptSection · object[]"},"medium":{"type":"string","enum":["web_voice","telephony","sms","email","chatbot","api_text","chat_app","softphone"],"title":"ConversationMediumType","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.medium","typeLabel":"enum\u003cstring>"},"conversation_seeder":{"items":{"type":"string","uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.conversation_seeder.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Conversation Seeder","uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.conversation_seeder","typeLabel":"string[]"},"structured_conversation_seeder":{"items":{"properties":{"role":{"type":"string","enum":["system","user","assistant","tool"],"title":"MessageRole","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.structured_conversation_seeder.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"content":{"type":"string","title":"Content","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.structured_conversation_seeder.items.[INDEX].content","typeLabel":"string"},"tool_calls":{"items":{"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.structured_conversation_seeder.items.[INDEX].tool_calls.items.[INDEX].name","typeLabel":"string"},"arguments":{"additionalProperties":true,"type":"object","title":"Arguments","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.structured_conversation_seeder.items.[INDEX].tool_calls.items.[INDEX].arguments","typeLabel":"Arguments · object"}},"type":"object","required":["name","arguments"],"title":"MessageToolCall","uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.structured_conversation_seeder.items.[INDEX].tool_calls.items.[INDEX]","typeLabel":"MessageToolCall · object"},"type":"array","title":"Tool Calls","uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.structured_conversation_seeder.items.[INDEX].tool_calls","typeLabel":"MessageToolCall · object[]"}},"type":"object","required":["role","content"],"title":"Message","uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.structured_conversation_seeder.items.[INDEX]","typeLabel":"Message · object"},"type":"array","title":"Structured Conversation Seeder","uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.structured_conversation_seeder","typeLabel":"Message · object[]"},"type":{"type":"string","enum":["outbound","inbound"],"title":"CallType","default":"outbound","uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.type","typeLabel":"enum\u003cstring>"},"extend_sections":{"type":"boolean","title":"Extend Sections","description":"When enabled, it will append stage sections to the original system prompt instead of overriding it.","default":false,"uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.extend_sections","typeLabel":"boolean"},"extend_conversation_seeder":{"type":"boolean","title":"Extend Conversation Seeder","description":"When enabled, it will append stage conversation seeder to the original conversation seeder instead of overriding it.","default":false,"uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0.extend_conversation_seeder","typeLabel":"boolean"}},"uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.0","typeLabel":"EmbeddedSystemPromptSubModel · object"},{"type":"null","uniqueKey":"system_prompt.oneOf.0.inbound.oneOf.1","typeLabel":"null"}],"uniqueKey":"system_prompt.oneOf.0.inbound","typeLabel":"EmbeddedSystemPromptSubModel · object | null"},"outbound":{"oneOf":[{"type":"object","title":"EmbeddedSystemPromptSubModel","required":["sections","medium"],"properties":{"sections":{"items":{"properties":{"title":{"type":"string","title":"Title","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.sections.items.[INDEX].title","typeLabel":"string"},"description":{"type":"string","title":"Description","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.sections.items.[INDEX].description","typeLabel":"string"}},"type":"object","required":["title","description"],"title":"SystemPromptSection","uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.sections.items.[INDEX]","typeLabel":"SystemPromptSection · object"},"type":"array","title":"Sections","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.sections","typeLabel":"SystemPromptSection · object[]"},"medium":{"type":"string","enum":["web_voice","telephony","sms","email","chatbot","api_text","chat_app","softphone"],"title":"ConversationMediumType","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.medium","typeLabel":"enum\u003cstring>"},"conversation_seeder":{"items":{"type":"string","uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.conversation_seeder.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Conversation Seeder","uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.conversation_seeder","typeLabel":"string[]"},"structured_conversation_seeder":{"items":{"properties":{"role":{"type":"string","enum":["system","user","assistant","tool"],"title":"MessageRole","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.structured_conversation_seeder.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"content":{"type":"string","title":"Content","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.structured_conversation_seeder.items.[INDEX].content","typeLabel":"string"},"tool_calls":{"items":{"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.structured_conversation_seeder.items.[INDEX].tool_calls.items.[INDEX].name","typeLabel":"string"},"arguments":{"additionalProperties":true,"type":"object","title":"Arguments","isRequired":true,"uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.structured_conversation_seeder.items.[INDEX].tool_calls.items.[INDEX].arguments","typeLabel":"Arguments · object"}},"type":"object","required":["name","arguments"],"title":"MessageToolCall","uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.structured_conversation_seeder.items.[INDEX].tool_calls.items.[INDEX]","typeLabel":"MessageToolCall · object"},"type":"array","title":"Tool Calls","uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.structured_conversation_seeder.items.[INDEX].tool_calls","typeLabel":"MessageToolCall · object[]"}},"type":"object","required":["role","content"],"title":"Message","uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.structured_conversation_seeder.items.[INDEX]","typeLabel":"Message · object"},"type":"array","title":"Structured Conversation Seeder","uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.structured_conversation_seeder","typeLabel":"Message · object[]"},"type":{"type":"string","enum":["outbound","inbound"],"title":"CallType","default":"outbound","uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.type","typeLabel":"enum\u003cstring>"},"extend_sections":{"type":"boolean","title":"Extend Sections","description":"When enabled, it will append stage sections to the original system prompt instead of overriding it.","default":false,"uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.extend_sections","typeLabel":"boolean"},"extend_conversation_seeder":{"type":"boolean","title":"Extend Conversation Seeder","description":"When enabled, it will append stage conversation seeder to the original conversation seeder instead of overriding it.","default":false,"uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0.extend_conversation_seeder","typeLabel":"boolean"}},"uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.0","typeLabel":"EmbeddedSystemPromptSubModel · object"},{"type":"null","uniqueKey":"system_prompt.oneOf.0.outbound.oneOf.1","typeLabel":"null"}],"uniqueKey":"system_prompt.oneOf.0.outbound","typeLabel":"EmbeddedSystemPromptSubModel · object | null"}},"uniqueKey":"system_prompt.oneOf.0","typeLabel":"EmbeddedSystemPromptModel · object"},{"type":"null","uniqueKey":"system_prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"system_prompt","typeLabel":"EmbeddedSystemPromptModel · object | null"},"disable_system_dispositioning":{"oneOf":[{"type":"boolean","title":"Disable System Dispositioning","default":false,"uniqueKey":"disable_system_dispositioning.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Disable System Dispositioning","default":false,"uniqueKey":"disable_system_dispositioning.oneOf.1","typeLabel":"null"}],"uniqueKey":"disable_system_dispositioning","typeLabel":"boolean | null"},"campaign_duration":{"oneOf":[{"type":"object","title":"CampaignDuration","properties":{"campaign_start_date":{"oneOf":[{"type":"string","title":"Campaign Start Date","format":"date-time","uniqueKey":"campaign_duration.oneOf.0.campaign_start_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Campaign Start Date","uniqueKey":"campaign_duration.oneOf.0.campaign_start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign_duration.oneOf.0.campaign_start_date","typeLabel":"string\u003cdate-time> | null"},"campaign_end_date":{"oneOf":[{"type":"string","title":"Campaign End Date","format":"date-time","uniqueKey":"campaign_duration.oneOf.0.campaign_end_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Campaign End Date","uniqueKey":"campaign_duration.oneOf.0.campaign_end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign_duration.oneOf.0.campaign_end_date","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"campaign_duration.oneOf.0","typeLabel":"CampaignDuration · object"},{"type":"null","uniqueKey":"campaign_duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign_duration","typeLabel":"CampaignDuration · object | null"},"disable_amd":{"oneOf":[{"type":"boolean","title":"Disable Amd","description":"Deprecated legacy AMD toggle for old carrier paths. New voice engines use per-agent amd settings.","default":false,"deprecated":true,"uniqueKey":"disable_amd.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Disable Amd","description":"Deprecated legacy AMD toggle for old carrier paths. New voice engines use per-agent amd settings.","default":false,"deprecated":true,"uniqueKey":"disable_amd.oneOf.1","typeLabel":"null"}],"uniqueKey":"disable_amd","typeLabel":"boolean | null"},"answering_machine_detection":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Enable answering machine detection for outbound calls. Default: true.","default":true,"uniqueKey":"answering_machine_detection.enabled","typeLabel":"boolean"},"interrupt_on_machine":{"type":"boolean","title":"Interrupt On Machine","description":"Interrupt any pending agent speech when AMD detects a machine result. Default: true.","default":true,"uniqueKey":"answering_machine_detection.interrupt_on_machine","typeLabel":"boolean"},"machine_ivr_behavior":{"type":"string","enum":["native_ivr","continue","hang_up"],"title":"AmdIvrBehavior","description":"Behavior when AMD detects machine-ivr, such as an IVR menu. native_ivr starts native IVR navigation, continue keeps the call active without native IVR navigation, and hang_up terminates the call. Default: native_ivr.","default":"native_ivr","uniqueKey":"answering_machine_detection.machine_ivr_behavior","typeLabel":"enum\u003cstring>"},"machine_vm_behavior":{"type":"string","enum":["continue","hang_up","leave_message"],"title":"AmdVoicemailBehavior","description":"Behavior when AMD detects machine-vm, meaning voicemail where leaving a message is possible. leave_message plays voicemail_message when present, otherwise the v3 worker generates a concise voicemail. Default: hang_up.","default":"hang_up","uniqueKey":"answering_machine_detection.machine_vm_behavior","typeLabel":"enum\u003cstring>"},"machine_unavailable_behavior":{"type":"string","enum":["continue","hang_up"],"title":"AmdUnavailableBehavior","description":"Behavior when AMD detects machine-unavailable, such as a full mailbox, unset voicemail, or unreachable callee. leave_message is intentionally not supported. Default: hang_up.","default":"hang_up","uniqueKey":"answering_machine_detection.machine_unavailable_behavior","typeLabel":"enum\u003cstring>"},"voicemail_message":{"oneOf":[{"type":"string","title":"Voicemail Message","description":"Optional message to leave when machine_vm_behavior is leave_message. Default: null. If omitted, the v3 worker generates a concise voicemail.","uniqueKey":"answering_machine_detection.voicemail_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Voicemail Message","description":"Optional message to leave when machine_vm_behavior is leave_message. Default: null. If omitted, the v3 worker generates a concise voicemail.","uniqueKey":"answering_machine_detection.voicemail_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"answering_machine_detection.voicemail_message","typeLabel":"string | null"},"llm_model":{"oneOf":[{"type":"string","title":"Llm Model","description":"Optional inference model ID or provider model string for AMD greeting classification. Default when omitted: google/gemini-3.1-flash-lite via inference when available; otherwise the session LLM.","uniqueKey":"answering_machine_detection.llm_model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Llm Model","description":"Optional inference model ID or provider model string for AMD greeting classification. Default when omitted: google/gemini-3.1-flash-lite via inference when available; otherwise the session LLM.","uniqueKey":"answering_machine_detection.llm_model.oneOf.1","typeLabel":"null"}],"uniqueKey":"answering_machine_detection.llm_model","typeLabel":"string | null"},"stt_model":{"oneOf":[{"type":"string","title":"Stt Model","description":"Optional inference model ID or provider model string for AMD greeting transcription. Default when omitted: cartesia/ink-whisper via inference when available; otherwise session transcripts.","uniqueKey":"answering_machine_detection.stt_model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Stt Model","description":"Optional inference model ID or provider model string for AMD greeting transcription. Default when omitted: cartesia/ink-whisper via inference when available; otherwise session transcripts.","uniqueKey":"answering_machine_detection.stt_model.oneOf.1","typeLabel":"null"}],"uniqueKey":"answering_machine_detection.stt_model","typeLabel":"string | null"},"detection_options":{"oneOf":[{"type":"object","title":"AnsweringMachineDetectionOptions","description":"Optional voice engine v3 AMD timing thresholds and classification prompt overrides. Default: null, which uses the standard AMD thresholds and prompt.","properties":{"human_speech_threshold":{"oneOf":[{"type":"number","title":"Human Speech Threshold","description":"Maximum short-greeting speech duration in seconds for the fast-path human heuristic. Default when omitted: 2.5 seconds.","uniqueKey":"answering_machine_detection.detection_options.oneOf.0.human_speech_threshold.oneOf.0","typeLabel":"number"},{"type":"null","title":"Human Speech Threshold","description":"Maximum short-greeting speech duration in seconds for the fast-path human heuristic. Default when omitted: 2.5 seconds.","uniqueKey":"answering_machine_detection.detection_options.oneOf.0.human_speech_threshold.oneOf.1","typeLabel":"null"}],"uniqueKey":"answering_machine_detection.detection_options.oneOf.0.human_speech_threshold","typeLabel":"number | null"},"human_silence_threshold":{"oneOf":[{"type":"number","title":"Human Silence Threshold","description":"Silence duration in seconds after a short greeting before voice engine v3 settles the AMD result as human. Default when omitted: 0.5 seconds.","uniqueKey":"answering_machine_detection.detection_options.oneOf.0.human_silence_threshold.oneOf.0","typeLabel":"number"},{"type":"null","title":"Human Silence Threshold","description":"Silence duration in seconds after a short greeting before voice engine v3 settles the AMD result as human. Default when omitted: 0.5 seconds.","uniqueKey":"answering_machine_detection.detection_options.oneOf.0.human_silence_threshold.oneOf.1","typeLabel":"null"}],"uniqueKey":"answering_machine_detection.detection_options.oneOf.0.human_silence_threshold","typeLabel":"number | null"},"machine_silence_threshold":{"oneOf":[{"type":"number","title":"Machine Silence Threshold","description":"Silence duration in seconds after machine-like speech before voice engine v3 emits a machine verdict. Default when omitted: 1.5 seconds.","uniqueKey":"answering_machine_detection.detection_options.oneOf.0.machine_silence_threshold.oneOf.0","typeLabel":"number"},{"type":"null","title":"Machine Silence Threshold","description":"Silence duration in seconds after machine-like speech before voice engine v3 emits a machine verdict. Default when omitted: 1.5 seconds.","uniqueKey":"answering_machine_detection.detection_options.oneOf.0.machine_silence_threshold.oneOf.1","typeLabel":"null"}],"uniqueKey":"answering_machine_detection.detection_options.oneOf.0.machine_silence_threshold","typeLabel":"number | null"},"no_speech_threshold":{"oneOf":[{"type":"number","title":"No Speech Threshold","description":"Maximum seconds to wait for any greeting speech before settling as machine-unavailable. Default when omitted: 10.0 seconds.","uniqueKey":"answering_machine_detection.detection_options.oneOf.0.no_speech_threshold.oneOf.0","typeLabel":"number"},{"type":"null","title":"No Speech Threshold","description":"Maximum seconds to wait for any greeting speech before settling as machine-unavailable. Default when omitted: 10.0 seconds.","uniqueKey":"answering_machine_detection.detection_options.oneOf.0.no_speech_threshold.oneOf.1","typeLabel":"null"}],"uniqueKey":"answering_machine_detection.detection_options.oneOf.0.no_speech_threshold","typeLabel":"number | null"},"timeout":{"oneOf":[{"type":"number","title":"Timeout","description":"Maximum total AMD detection time in seconds before voice engine v3 settles with the evidence available. Default when omitted: 20.0 seconds.","uniqueKey":"answering_machine_detection.detection_options.oneOf.0.timeout.oneOf.0","typeLabel":"number"},{"type":"null","title":"Timeout","description":"Maximum total AMD detection time in seconds before voice engine v3 settles with the evidence available. Default when omitted: 20.0 seconds.","uniqueKey":"answering_machine_detection.detection_options.oneOf.0.timeout.oneOf.1","typeLabel":"null"}],"uniqueKey":"answering_machine_detection.detection_options.oneOf.0.timeout","typeLabel":"number | null"},"prompt":{"oneOf":[{"type":"string","title":"Prompt","description":"Optional classification prompt override for the AMD LLM classifier. Default when omitted: the standard AMD classification prompt.","uniqueKey":"answering_machine_detection.detection_options.oneOf.0.prompt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Prompt","description":"Optional classification prompt override for the AMD LLM classifier. Default when omitted: the standard AMD classification prompt.","uniqueKey":"answering_machine_detection.detection_options.oneOf.0.prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"answering_machine_detection.detection_options.oneOf.0.prompt","typeLabel":"string | null"}},"uniqueKey":"answering_machine_detection.detection_options.oneOf.0","typeLabel":"AnsweringMachineDetectionOptions · object"},{"type":"null","description":"Optional voice engine v3 AMD timing thresholds and classification prompt overrides. Default: null, which uses the standard AMD thresholds and prompt.","uniqueKey":"answering_machine_detection.detection_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"answering_machine_detection.detection_options","typeLabel":"AnsweringMachineDetectionOptions · object | null"}},"type":"object","title":"AnsweringMachineDetectionSettings","description":"Deprecated campaign-level answering machine detection settings. Use per-agent `amd` settings instead. Existing old engines may still read this field.","deprecated":true,"uniqueKey":"answering_machine_detection","typeLabel":"AnsweringMachineDetectionSettings · object"},"custom_fields":{"oneOf":[{"type":"object","title":"Custom Fields","additionalProperties":true,"uniqueKey":"custom_fields.oneOf.0","typeLabel":"Custom Fields · object"},{"type":"null","title":"Custom Fields","uniqueKey":"custom_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields","typeLabel":"Custom Fields · object | null"},"a2p_status":{"oneOf":[{"type":"string","title":"A2PStatus","description":"Use organization.twilio.a2p_status instead.","enum":["rejected","verified","pending","unknown"],"deprecated":true,"uniqueKey":"a2p_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Use organization.twilio.a2p_status instead.","deprecated":true,"uniqueKey":"a2p_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"a2p_status","typeLabel":"enum\u003cstring> | null"},"initial_contact_medium":{"oneOf":[{"type":"string","title":"ConversationMediumType","enum":["web_voice","telephony","sms","email","chatbot","api_text","chat_app","softphone"],"uniqueKey":"initial_contact_medium.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"initial_contact_medium.oneOf.1","typeLabel":"null"}],"uniqueKey":"initial_contact_medium","typeLabel":"enum\u003cstring> | null"},"precall_tasks_execution_mode":{"oneOf":[{"type":"string","title":"PreCallTaskExecutionMode","description":"Inbound PreCallTasks can be executed:\n1. During the ringing phase (prolonged_ringing) - the tasks will be executed while the call is ringing.\n Agent will pick up the call only after the tasks are completed.\n Max duration is 10 seconds.","default":"prolonged_ringing","enum":["prolonged_ringing"],"uniqueKey":"precall_tasks_execution_mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","default":"prolonged_ringing","uniqueKey":"precall_tasks_execution_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"precall_tasks_execution_mode","typeLabel":"enum\u003cstring> | null"},"inbound_lead_list":{"oneOf":[{"type":"string","title":"Inbound Lead List","description":"The ID of the lead list associated with this campaign. Used to track and manage inbound leads.","uniqueKey":"inbound_lead_list.oneOf.0","typeLabel":"string"},{"type":"null","title":"Inbound Lead List","description":"The ID of the lead list associated with this campaign. Used to track and manage inbound leads.","uniqueKey":"inbound_lead_list.oneOf.1","typeLabel":"null"}],"uniqueKey":"inbound_lead_list","typeLabel":"string | null"},"telephony_outbound_caller_id":{"oneOf":[{"type":"string","title":"Telephony Outbound Caller Id","description":"Optional ObjectId referencing the caller ID to be used when making outbound phone calls for this campaign.","uniqueKey":"telephony_outbound_caller_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Telephony Outbound Caller Id","description":"Optional ObjectId referencing the caller ID to be used when making outbound phone calls for this campaign.","uniqueKey":"telephony_outbound_caller_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"telephony_outbound_caller_id","typeLabel":"string | null"},"source":{"oneOf":[{"type":"object","title":"CampaignSourceModel","description":"Tracks the source campaign this was cloned from.","required":["campaign_id","account_id"],"properties":{"campaign_id":{"type":"string","title":"Campaign Id","isRequired":true,"uniqueKey":"source.oneOf.0.campaign_id","typeLabel":"string"},"account_id":{"type":"string","title":"Account Id","isRequired":true,"uniqueKey":"source.oneOf.0.account_id","typeLabel":"string"},"snapshot_id":{"oneOf":[{"type":"string","title":"Snapshot Id","uniqueKey":"source.oneOf.0.snapshot_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Snapshot Id","uniqueKey":"source.oneOf.0.snapshot_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.oneOf.0.snapshot_id","typeLabel":"string | null"},"pending_publish":{"oneOf":[{"type":"object","title":"PendingPublish","description":"Stored on a clone when a publish was blocked due to merge conflicts.","required":["source_snapshot_id","source_snapshot_tag","conflicts"],"properties":{"source_snapshot_id":{"type":"string","title":"Source Snapshot Id","isRequired":true,"uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.source_snapshot_id","typeLabel":"string"},"source_snapshot_tag":{"type":"string","title":"Source Snapshot Tag","isRequired":true,"uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.source_snapshot_tag","typeLabel":"string"},"conflicts":{"items":{"properties":{"conflict_type":{"type":"string","enum":["field","entity_deleted_by_clone","entity_deleted_by_source"],"title":"ConflictType","isRequired":true,"uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts.items.[INDEX].conflict_type","typeLabel":"enum\u003cstring>"},"entity_type":{"type":"string","title":"Entity Type","description":"Entity type (e.g. agent, campaign, role, disposition, task)","isRequired":true,"uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts.items.[INDEX].entity_type","typeLabel":"string"},"entity_id":{"oneOf":[{"type":"string","title":"Entity Id","description":"Entity ID. None for top-level conflicts.","uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts.items.[INDEX].entity_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Entity Id","description":"Entity ID. None for top-level conflicts.","uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts.items.[INDEX].entity_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts.items.[INDEX].entity_id","typeLabel":"string | null"},"entity_name":{"oneOf":[{"type":"string","title":"Entity Name","uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts.items.[INDEX].entity_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Entity Name","uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts.items.[INDEX].entity_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts.items.[INDEX].entity_name","typeLabel":"string | null"},"field":{"oneOf":[{"type":"string","title":"Field","description":"The conflicting field name. Only set for field conflicts.","uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","title":"Field","description":"The conflicting field name. Only set for field conflicts.","uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts.items.[INDEX].field","typeLabel":"string | null"},"base_value":{"oneOf":[{"title":"Base Value"}],"uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts.items.[INDEX].base_value","typeLabel":"any"},"source_value":{"oneOf":[{"title":"Source Value"}],"uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts.items.[INDEX].source_value","typeLabel":"any"},"clone_value":{"oneOf":[{"title":"Clone Value"}],"uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts.items.[INDEX].clone_value","typeLabel":"any"}},"type":"object","required":["conflict_type","entity_type"],"title":"PublishConflict","description":"A single conflict between source and clone detected during 3-way merge.","uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts.items.[INDEX]","typeLabel":"PublishConflict · object"},"type":"array","title":"Conflicts","isRequired":true,"uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.conflicts","typeLabel":"PublishConflict · object[]"},"created_at":{"type":"string","format":"date-time","title":"Created At","uniqueKey":"source.oneOf.0.pending_publish.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"source.oneOf.0.pending_publish.oneOf.0","typeLabel":"PendingPublish · object"},{"type":"null","uniqueKey":"source.oneOf.0.pending_publish.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.oneOf.0.pending_publish","typeLabel":"PendingPublish · object | null"}},"uniqueKey":"source.oneOf.0","typeLabel":"CampaignSourceModel · object"},{"type":"null","uniqueKey":"source.oneOf.1","typeLabel":"null"}],"uniqueKey":"source","typeLabel":"CampaignSourceModel · object | null"}},"type":"object","required":["name","status"],"title":"CampaignModelResponse","uniqueKey":"","typeLabel":"CampaignModelResponse · object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","status":"CREATED","id":"\u003cstring>","account_id":"\u003cstring>","agents":["\u003cstring>"],"agent_snapshot_map":{},"distribution_strategy":"random","distribution_settings":{"percentages":{},"last_assigned_agent_index":-1},"distribution_by_medium":{},"phone_numbers":["\u003cstring>"],"inbound_phone_numbers":["\u003cstring>"],"claimed_phone_numbers":{},"dispositions":[{"id":"\u003cstring>","name":"\u003cstring>","parent_disposition":"\u003cstring>","description":"\u003cstring>","color":"#A5A5A5","contacted":true,"conversion":true,"blocklist_level":"CAMPAIGN","enabled":true}],"disposition_instructions":"\u003cstring>","disposition_level_2_instructions":"\u003cstring>","disposition_level_3_prompt":"\u003cstring>","call_summary_description":"\u003cstring>","disposition_level_3_reasoning":"none","disposition_level_3_model":"gpt-5.4","rules":{"call_limit":123,"call_window":[{"weekday":1,"start_time":1179,"end_time":1179}],"messenger_disposition_threshold_in_minutes":123,"medium_response_settings":{},"api_text_disposition_threshold_in_minutes":123,"should_answer_policy":{"enabled":false,"mode":"suppress_only","enabled_mediums":["web_voice"],"exact_match_enabled":true,"jaccard_enabled":true,"suppress_threshold":0.85,"fuzzy_threshold":0.5,"llm_judge_enabled":false,"llm_judge_always":false,"llm_judge_action":"rewrite","model":"gpt-5.4","timeout_seconds":10,"num_retries":1,"max_consecutive_suppressions":2,"on_suppression_limit_reached":"force_send","suppression_history_enabled":true,"suppression_history_max_size":10,"llm_judge_prompt_markdown":"\u003cstring>","llm_rewrite_prompt_markdown":"\u003cstring>"},"message_reaction_policy":{"action":"completely_ignore","enabled_mediums":["web_voice"]},"session_timeout":{"days":0,"hours":0,"minutes":0},"llm_fallback":{"cross_family":true}},"enabled":true,"history":{"last_modified_at":"2023-11-07T05:31:56Z","revision":0,"created_at":"2023-11-07T05:31:56Z","created_by":"unknown","last_modified_by":"unknown"},"tasks":[{"task_type":"try_again","task_settings":{},"id":"\u003cstring>","name":"\u003cstring>","type":"post_call","condition":{"call_count":[123],"dispositions":[{"field":"twilio_status","values":["\u003cstring>"]}],"ai_conditions":[{"condition":"Did the lead say there is a child in the car?","confidence_threshold":0.5}],"eval_conditions":[{"grader_name":"\u003cstring>","values":["\u003cstring>"],"passed":true}],"expression_conditions":[{"expression":"conversation.action_runs.call_transfer.last.success"}]},"required":false,"enabled":true}],"call_now_threshold_recall_time":123,"external_context_template":"\u003cstring>","system_prompt":{"inbound":{"sections":[{"title":"\u003cstring>","description":"\u003cstring>"}],"medium":"web_voice","conversation_seeder":["\u003cstring>"],"structured_conversation_seeder":[{"role":"system","content":"\u003cstring>","tool_calls":[{"name":"\u003cstring>","arguments":{}}]}],"type":"outbound","extend_sections":false,"extend_conversation_seeder":false},"outbound":{"sections":[{"title":"\u003cstring>","description":"\u003cstring>"}],"medium":"web_voice","conversation_seeder":["\u003cstring>"],"structured_conversation_seeder":[{"role":"system","content":"\u003cstring>","tool_calls":[{"name":"\u003cstring>","arguments":{}}]}],"type":"outbound","extend_sections":false,"extend_conversation_seeder":false}},"disable_system_dispositioning":false,"campaign_duration":{"campaign_start_date":"2023-11-07T05:31:56Z","campaign_end_date":"2023-11-07T05:31:56Z"},"disable_amd":false,"answering_machine_detection":{"enabled":true,"interrupt_on_machine":true,"machine_ivr_behavior":"native_ivr","machine_vm_behavior":"hang_up","machine_unavailable_behavior":"hang_up","voicemail_message":"\u003cstring>","llm_model":"\u003cstring>","stt_model":"\u003cstring>","detection_options":{"human_speech_threshold":123,"human_silence_threshold":123,"machine_silence_threshold":123,"no_speech_threshold":123,"timeout":123,"prompt":"\u003cstring>"}},"custom_fields":{},"a2p_status":"rejected","initial_contact_medium":"web_voice","precall_tasks_execution_mode":"prolonged_ringing","inbound_lead_list":"\u003cstring>","telephony_outbound_caller_id":"\u003cstring>","source":{"campaign_id":"\u003cstring>","account_id":"\u003cstring>","snapshot_id":"\u003cstring>","pending_publish":{"source_snapshot_id":"\u003cstring>","source_snapshot_tag":"\u003cstring>","conflicts":[{"conflict_type":"field","entity_type":"\u003cstring>","entity_id":"\u003cstring>","entity_name":"\u003cstring>","field":"\u003cstring>","base_value":"\u003cunknown>","source_value":"\u003cunknown>","clone_value":"\u003cunknown>"}],"created_at":"2023-11-07T05:31:56Z"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"0d782398-05c4-4cb1-90ce-d39cc092faf9":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5cb8d4d8-3055-4e20-b47c-7fa254a21fb4":{"APIKeyHeader":{"type":"apiKey","description":"Your API key for authentication.","in":"header","name":"X-API-KEY","scopes":[],"schemeName":"APIKeyHeader"},"OrgImpersonation":{"type":"apiKey","in":"header","name":"x-org-id","description":"Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.","scopes":[],"schemeName":"OrgImpersonation"}},"2682f291-2a4c-4538-a889-beb7c2e1dcec":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"token"}},"scopes":[],"schemeName":"OAuth2PasswordBearer"},"OrgImpersonation":{"type":"apiKey","in":"header","name":"x-org-id","description":"Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.","scopes":[],"schemeName":"OrgImpersonation"}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Your API key for authentication.","in":"header","name":"X-API-KEY","scopes":[],"schemeName":"APIKeyHeader"},"schema":{"title":"X-API-KEY","type":"string","description":"Your API key for authentication.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKeyHeader","name":"X-API-KEY"},{"scheme":{"type":"apiKey","in":"header","name":"x-org-id","description":"Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.","scopes":[],"schemeName":"OrgImpersonation"},"schema":{"title":"x-org-id","type":"string","description":"Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"OrgImpersonation","name":"x-org-id"}],"title":"APIKeyHeader \u0026 OrgImpersonation"},{"schemes":[{"scheme":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"token"}},"scopes":[],"schemeName":"OAuth2PasswordBearer"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"The access token received from the authorization server in the OAuth 2.0 flow.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2PasswordBearer","name":"Authorization"},{"scheme":{"type":"apiKey","in":"header","name":"x-org-id","description":"Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.","scopes":[],"schemeName":"OrgImpersonation"},"schema":{"title":"x-org-id","type":"string","description":"Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"OrgImpersonation","name":"x-org-id"}],"title":"OAuth2PasswordBearer \u0026 OrgImpersonation"}]},"originalFileLocation":"docs/api-reference/openapi.json"},"subdomain":"eqho","siteName":"Eqho API","title":"Get Campaign By Id - Eqho API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T21:19:58.576Z","originalFileLocation":"docs/api-reference/campaigns/get-campaign.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Eqho API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/eqho/oxggiVRmRK8tBi6H/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/eqho/oxggiVRmRK8tBi6H/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/eqho/oxggiVRmRK8tBi6H/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/eqho/oxggiVRmRK8tBi6H/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/eqho/oxggiVRmRK8tBi6H/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/eqho/oxggiVRmRK8tBi6H/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/eqho/oxggiVRmRK8tBi6H/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/eqho/oxggiVRmRK8tBi6H/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/eqho/oxggiVRmRK8tBi6H/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Campaign By Id - Eqho API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Eqho API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.eqho.ai/docs/api-reference/campaigns/get-campaign\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://eqho.mintlify.site/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Get+Campaign+By+Id\u0026amp;theme=ccef9572dea6578cd6d37915\u0026amp;signature=9b2bd0174c0ef7fdd420180336c3d5ddb4a78b29b4330084c8bff3fada700a2c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Campaign By Id - Eqho API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://eqho.mintlify.site/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Get+Campaign+By+Id\u0026amp;theme=ccef9572dea6578cd6d37915\u0026amp;signature=9b2bd0174c0ef7fdd420180336c3d5ddb4a78b29b4330084c8bff3fada700a2c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/eqho/oxggiVRmRK8tBi6H/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Eqho API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#502fef\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.eqho.ai/docs/api-reference/campaigns/get-campaign\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/campaigns/get-campaign.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.eqho.ai/#organization\",\"name\":\"Eqho API\",\"url\":\"https://docs.eqho.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/eqho/u4ffk1m_kvB69lIL/docs/logo/light.svg?fit=max\u0026auto=format\u0026n=u4ffk1m_kvB69lIL\u0026q=85\u0026s=b9ce3b45ff5bb64ba3996856006b2ef7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.eqho.ai#website\",\"name\":\"Eqho API\",\"url\":\"https://docs.eqho.ai\",\"publisher\":{\"@id\":\"https://docs.eqho.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.eqho.ai/docs/api-reference/campaigns/get-campaign#webpage\",\"url\":\"https://docs.eqho.ai/docs/api-reference/campaigns/get-campaign\",\"name\":\"Get Campaign By Id\",\"dateModified\":\"2026-11-03T21:19:58.576Z\",\"isPartOf\":{\"@id\":\"https://docs.eqho.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.eqho.ai/docs/api-reference/campaigns/get-campaign#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.eqho.ai/docs/api-reference/campaigns/get-campaign#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.eqho.ai/docs/api-reference/actions/get-actions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Campaigns\",\"item\":\"https://docs.eqho.ai/docs/api-reference/campaigns/get-campaigns\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Campaign By Id\",\"item\":\"https://docs.eqho.ai/docs/api-reference/campaigns/get-campaign\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.eqho.ai/docs/api-reference/campaigns/get-campaign#apireference\",\"headline\":\"Get Campaign By Id\",\"name\":\"Get Campaign By Id\",\"url\":\"https://docs.eqho.ai/docs/api-reference/campaigns/get-campaign\",\"mainEntityOfPage\":{\"@id\":\"https://docs.eqho.ai/docs/api-reference/campaigns/get-campaign#webpage\"},\"dateModified\":\"2026-11-03T21:19:58.576Z\",\"publisher\":{\"@id\":\"https://docs.eqho.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.eqho.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Eqho API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Eqho API","nav":{"global":null,"tabs":[{"tab":"API References","groups":[{"group":"API Reference","pages":[{"title":"Eqho API Overview","href":"/docs/api-reference/eqho-api-overview"},{"title":"Creating API Keys","href":"/docs/api-reference/create-api-keys"},{"title":"Authentication","href":"/docs/api-reference/authentication"}]},{"group":"Endpoints","pages":[{"group":"Actions","pages":[{"title":"Get Actions","openapi":"GET /v1/actions","href":"/docs/api-reference/actions/get-actions"},{"title":"Create Action","openapi":"POST /v1/actions","href":"/docs/api-reference/actions/create-action"},{"title":"Get Action By Id","openapi":"GET /v1/actions/{action_id}","href":"/docs/api-reference/actions/get-action"},{"title":"Update Action","openapi":"PUT /v1/actions/{action_id}","href":"/docs/api-reference/actions/update-action"},{"title":"Delete Action","openapi":"DELETE /v1/actions/{action_id}","href":"/docs/api-reference/actions/delete-action"},{"title":"Get Action Types","openapi":"GET /v1/actions/types","href":"/docs/api-reference/actions/get-action-types"},{"title":"Get Global Action Templates","openapi":"GET /v1/actions/templates/global","href":"/docs/api-reference/actions/get-global-templates"}]},{"group":"Agents","pages":[{"title":"Get Agents","openapi":"GET /v1/agents","href":"/docs/api-reference/agents/get-agents"},{"title":"Create Agent","openapi":"POST /v1/agents","href":"/docs/api-reference/agents/create-agent"},{"title":"Get Agent By Id","openapi":"GET /v1/agents/{agent_id}","href":"/docs/api-reference/agents/get-agent"},{"title":"Update Agent","openapi":"PUT /v1/agents/{agent_id}","href":"/docs/api-reference/agents/update-agent"},{"title":"Delete Agent","openapi":"DELETE /v1/agents/{agent_id}","href":"/docs/api-reference/agents/delete-agent"},{"title":"Get Agent Details","openapi":"GET /v1/agents/{agent_id}/details","href":"/docs/api-reference/agents/get-agent-details"},{"title":"Try Agent","openapi":"POST /v1/agents/{agent_id}/try","href":"/docs/api-reference/agents/try-agent"},{"title":"Get Supported Languages","openapi":"GET /v1/agents/languages/all","href":"/docs/api-reference/agents/get-supported-languages"}]},{"group":"Call Now","pages":[{"title":"Call Now","openapi":"POST /v1/call-now/call-lead-now","href":"/docs/api-reference/call-now/call-now"}]},{"group":"Calls","pages":[{"title":"Get Calls","openapi":"GET /v1/calls","href":"/docs/api-reference/calls/get-calls"},{"title":"Get Call By Id","openapi":"GET /v1/calls/{call_id}","href":"/docs/api-reference/calls/get-call"},{"title":"Push External Context Into Call","openapi":"POST /v1/calls/{call_id}/external-context","href":"/docs/api-reference/calls/push-external-context"}]},{"group":"Campaigns","pages":[{"title":"Get Campaigns","openapi":"GET /v1/campaigns","href":"/docs/api-reference/campaigns/get-campaigns"},{"title":"Create Campaign","openapi":"POST /v1/campaigns","description":null,"href":"/docs/api-reference/campaigns/create-campaign"},{"title":"Get Campaign By Id","openapi":"GET /v1/campaigns/{campaign_id}","href":"/docs/api-reference/campaigns/get-campaign"},{"title":"Update Campaign","openapi":"PUT /v1/campaigns/{campaign_id}","description":null,"href":"/docs/api-reference/campaigns/update-campaign"},{"title":"Delete Campaign","openapi":"DELETE /v1/campaigns/{campaign_id}","href":"/docs/api-reference/campaigns/delete-campaign"}]},{"group":"Chat","pages":[{"title":"Chat","openapi":"POST /v1/chat","href":"/docs/api-reference/chat/chat"},{"title":"Voice Chat","openapi":"POST /v1/chat/voice","href":"/docs/api-reference/chat/voice"},{"title":"Chat Context","openapi":"POST /v1/chat/context","href":"/docs/api-reference/chat/context"}]},{"group":"Chat Widget","pages":[{"title":"Get Widget Configs","openapi":"GET /v1/chat-widget","href":"/docs/api-reference/chat-widget/index"},{"title":"Create Widget Config","openapi":"POST /v1/chat-widget","href":"/docs/api-reference/chat-widget/create"},{"title":"Get Widget Config By Id","openapi":"GET /v1/chat-widget/{widget_config_id}","href":"/docs/api-reference/chat-widget/show"},{"title":"Delete Widget Config","openapi":"DELETE /v1/chat-widget/{widget_config_id}","href":"/docs/api-reference/chat-widget/delete"}]},{"group":"Knowledge Base","pages":[{"title":"Get Knowledge Bases","openapi":"GET /v1/data-stores","href":"/docs/api-reference/knowledge-bases/get-knowledge-bases"},{"title":"Create Knowledge Base","openapi":"POST /v1/data-stores","href":"/docs/api-reference/knowledge-bases/create-knowledge-base"},{"title":"Get Knowledge Base By Id","openapi":"GET /v1/data-stores/{data_store_id}","href":"/docs/api-reference/knowledge-bases/get-knowledge-base"},{"title":"Update Knowledge Base","openapi":"PUT /v1/data-stores/{data_store_id}","href":"/docs/api-reference/knowledge-bases/update-knowledge-base"},{"title":"Delete Knowledge Base","openapi":"DELETE /v1/data-stores/{data_store_id}","href":"/docs/api-reference/knowledge-bases/delete-knowledge-base"},{"title":"Query Knowledge Base","openapi":"GET /v1/data-stores/search","href":"/docs/api-reference/knowledge-bases/query-knowledge-base"},{"title":"Upload Document","openapi":"POST /v1/data-stores/{data_store_id}/documents","href":"/docs/api-reference/knowledge-bases/upload-document"},{"title":"Delete Document","openapi":"DELETE /v1/data-stores/{data_store_id}/documents","href":"/docs/api-reference/knowledge-bases/delete-document"},{"title":"Upload URL","openapi":"POST /v1/data-stores/{data_store_id}/urls","href":"/docs/api-reference/knowledge-bases/upload-url"},{"title":"Delete URL","openapi":"DELETE /v1/data-stores/{data_store_id}/urls","href":"/docs/api-reference/knowledge-bases/delete-url"}]},{"group":"Lead Lists","pages":[{"title":"Get Lead Lists","openapi":"GET /v1/leads/lists","href":"/docs/api-reference/lead-lists/get-lead-lists"},{"title":"Create Lead List","openapi":"POST /v1/leads/lists","href":"/docs/api-reference/lead-lists/create-lead-list"},{"title":"Get Lead List By Id","openapi":"GET /v1/leads/lists/{list_id}","href":"/docs/api-reference/lead-lists/get-lead-list"},{"title":"Update Lead List","openapi":"PUT /v1/leads/lists/{list_id}","href":"/docs/api-reference/lead-lists/update-lead-list"},{"title":"Delete Lead List","openapi":"DELETE /v1/leads/lists/{list_id}","href":"/docs/api-reference/lead-lists/delete-lead-list"}]},{"group":"Leads","pages":[{"title":"Get Leads","openapi":"GET /v1/leads","href":"/docs/api-reference/leads/get-leads"},{"title":"Create Lead","openapi":"POST /v1/leads","href":"/docs/api-reference/leads/create-lead"},{"title":"Get Lead By Id","openapi":"GET /v1/leads/{lead_id}","href":"/docs/api-reference/leads/get-lead"},{"title":"Update Lead","openapi":"PUT /v1/leads/{lead_id}","href":"/docs/api-reference/leads/update-lead"},{"title":"Delete Lead","openapi":"DELETE /v1/leads/{lead_id}","href":"/docs/api-reference/leads/delete-lead"},{"title":"Search Lead","openapi":"GET /v1/leads/lookup","href":"/docs/api-reference/leads/lookup-lead"},{"title":"Bulk Upload Leads","openapi":"POST /v1/leads/bulk-upload","href":"/docs/api-reference/leads/bulk-upload"},{"title":"Remove Lead From Lists","openapi":"DELETE /v1/leads/{lead_id}/lists","href":"/docs/api-reference/leads/delete-from-lists"},{"title":"Add Phone Numbers To Black List","openapi":"POST /v1/leads/black_list","href":"/docs/api-reference/leads/add-to-blacklist"}]},{"group":"Mentions","pages":[{"title":"Get Mentions","openapi":"GET /v1/mentions","href":"/docs/api-reference/mentions/get-mentions"},{"title":"Get Mention By Id","openapi":"GET /v1/mentions/{mention_id}","href":"/docs/api-reference/mentions/get-mention-by-id"},{"title":"Create Mention","openapi":"POST /v1/mentions","href":"/docs/api-reference/mentions/create-mention"},{"title":"Delete Mention","openapi":"DELETE /v1/mentions/{mention_id}","href":"/docs/api-reference/mentions/delete-mention"}]},{"group":"Phone Numbers","pages":[{"title":"Get Available Phone Numbers","openapi":"GET /v1/phone-numbers/available","href":"/docs/api-reference/phone-numbers/get-available-numbers"},{"title":"Claim Phone Number","openapi":"POST /v1/phone-numbers","href":"/docs/api-reference/phone-numbers/claim-phone-number"},{"title":"Update Phone Number","openapi":"PATCH /v1/phone-numbers","href":"/docs/api-reference/phone-numbers/update-phone-number"},{"title":"Release Phone Number","openapi":"DELETE /v1/phone-numbers","href":"/docs/api-reference/phone-numbers/release-phone-number"}]},{"group":"Reports","pages":[{"title":"Get Disposition Report","openapi":"GET /v2/reports/dispositions","href":"/docs/api-reference/reports/get-dispositions"},{"title":"Get Metrics","openapi":"GET /v2/reports/metrics","href":"/docs/api-reference/reports/get-metrics"},{"title":"Get Reports Table Config","openapi":"GET /v1/reports/table-config","href":"/docs/api-reference/reports/get-table-config"},{"title":"Save Reports Table Config","openapi":"POST /v1/reports/table-config","href":"/docs/api-reference/reports/update-table-config"},{"title":"Get Available Metrics","openapi":"GET /v2/reports/metrics/available","href":"/docs/api-reference/reports/get-available-metrics"},{"title":"Get Evaluation Metrics","openapi":"GET /v2/reports/evaluation-metrics","href":"/docs/api-reference/reports/get-evaluation-metrics"},{"title":"Get Available Evaluation Metrics","openapi":"GET /v2/reports/evaluation-metrics/available","href":"/docs/api-reference/reports/get-available-evaluation-metrics"},{"title":"High interest metrics","href":"/docs/api-reference/reports/high-interest-metrics"}]},{"group":"Roles","pages":[{"title":"Get Roles","openapi":"GET /v1/roles","href":"/docs/api-reference/roles/get-roles"},{"title":"Create Role","openapi":"POST /v1/roles","href":"/docs/api-reference/roles/create-role"},{"title":"Get Role By Id","openapi":"GET /v1/roles/{role_id}","href":"/docs/api-reference/roles/get-role"},{"title":"Update Role","openapi":"PUT /v1/roles/{role_id}","href":"/docs/api-reference/roles/update-role"},{"title":"Delete Role","openapi":"DELETE /v1/roles/{role_id}","href":"/docs/api-reference/roles/delete-role"}]},{"group":"Scripts","pages":[{"title":"Get Scripts","openapi":"GET /v1/scripts","href":"/docs/api-reference/scripts/get-scripts"},{"title":"Create Script","openapi":"POST /v1/scripts","href":"/docs/api-reference/scripts/create-script"},{"title":"Get Script By Id","openapi":"GET /v1/scripts/{script_id}","href":"/docs/api-reference/scripts/get-script"},{"title":"Update Script","openapi":"PUT /v1/scripts/{script_id}","href":"/docs/api-reference/scripts/update-script"},{"title":"Delete Script","openapi":"DELETE /v1/scripts/{script_id}","href":"/docs/api-reference/scripts/delete-script"}]},{"group":"Simulations","pages":[{"group":"Scenarios","pages":[{"title":"Create Scenario","openapi":"POST /v1/simulation/scenarios","href":"/docs/api-reference/simulations/scenarios/create-scenario"},{"title":"Get Scenario","openapi":"GET /v1/simulation/scenarios/{scenario_id}","href":"/docs/api-reference/simulations/scenarios/get-scenario"},{"title":"Get Scenarios","openapi":"GET /v1/simulation/scenarios","href":"/docs/api-reference/simulations/scenarios/get-scenarios"},{"title":"Update Scenario","openapi":"PUT /v1/simulation/scenarios/{scenario_id}","href":"/docs/api-reference/simulations/scenarios/update-scenario"},{"title":"Delete Scenario","openapi":"DELETE /v1/simulation/scenarios/{scenario_id}","href":"/docs/api-reference/simulations/scenarios/delete-scenario"}]},{"group":"Scenario sets","pages":[{"title":"Create Scenario Set","openapi":"POST /v1/simulation/scenario-sets","href":"/docs/api-reference/simulations/scenario-sets/create-scenario-set"},{"title":"Get Scenario Set","openapi":"GET /v1/simulation/scenario-sets/{scenario_set_id}","href":"/docs/api-reference/simulations/scenario-sets/get-scenario-set"},{"title":"Get Scenario Sets","openapi":"GET /v1/simulation/scenario-sets","href":"/docs/api-reference/simulations/scenario-sets/list-scenario-sets"},{"title":"Update Scenario Set","openapi":"PUT /v1/simulation/scenario-sets/{scenario_set_id}","href":"/docs/api-reference/simulations/scenario-sets/update-scenario-set"},{"title":"Delete Scenario Set","openapi":"DELETE /v1/simulation/scenario-sets/{scenario_set_id}","href":"/docs/api-reference/simulations/scenario-sets/delete-scenario-set"}]},{"title":"Run Simulation","openapi":"POST /v1/simulation","href":"/docs/api-reference/simulations/run-simulation"},{"title":"Get Simulation Result","openapi":"GET /v1/simulation/results/{result_id}","href":"/docs/api-reference/simulations/show-result"},{"title":"Get Simulation Results","openapi":"GET /v1/simulation/results","href":"/docs/api-reference/simulations/get-results"},{"title":"Show Runs for a Simulation Result","openapi":"GET /v1/simulation/results/{result_id}/runs","href":"/docs/api-reference/simulations/list-result-runs"},{"title":"Show Simulation Runs","openapi":"GET /v1/simulation/run/{run_id}","href":"/docs/api-reference/simulations/show-simulation-run"}]},{"group":"Voices","pages":[{"title":"Get Voices","openapi":"GET /v1/voices","href":"/docs/api-reference/voices/get-voices"},{"title":"Update Voice","openapi":"PUT /v1/voices/{voice_id}","href":"/docs/api-reference/voices/update-voice"}]},{"group":"Webhooks","pages":[{"title":"Call Now","openapi":"POST /v1/webhooks/call-now","href":"/docs/api-reference/webhook/call-now"},{"title":"Call Lead Now","openapi":"POST /v1/webhooks/call-lead-now","href":"/docs/api-reference/webhook/call-lead-now"},{"title":"Create Lead and Call","openapi":"POST /v1/webhooks/create-and-call","href":"/docs/api-reference/webhook/create-and-call"}]}]}]}]},"basePath":"","title":"Get Campaign By Id - Eqho API","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}