Read the retained recording receipt and refresh nonterminal simulator progress. A terminal Failed or Cancelled receipt is returned as HTTP 200 with that state; during failure publication a nonterminal refresh can temporarily return 503 instead. Unknown or unavailable cleanup is not confirmed termination. A fresh authorized token for the same tenant can read an existing receipt. No request body is required.
Simulator state only. Completed means recording cleanup was confirmed, not that Assist/backend delivery occurred. Unknown requires reconciliation, not a new request to bypass admission.
True: all records written to TCP. False: at least one failed attempt. Null: no failure observed but no location requested or not all records sent. None of these proves Location parsing/correlation/backend delivery.
Optional enrichment when matching execution progress is available. May be absent even for location requests.
Show child attributes
⌘I
{"docsConfig":{"theme":"willow","$schema":"https://mintlify.com/docs.json","name":"GovWorx API Documentation","colors":{"primary":"#339af0","light":"#339af0","dark":"#339af0"},"logo":{"light":"https://mintcdn.com/govworx/0FFQLB-2pFQKMa2M/logo/GovWorx-Logo_light.png?fit=max\u0026auto=format\u0026n=0FFQLB-2pFQKMa2M\u0026q=85\u0026s=6f689d9f51a89e59482167234491c4ee","dark":"https://mintcdn.com/govworx/0FFQLB-2pFQKMa2M/logo/GovWorx-Logo-dark.png?fit=max\u0026auto=format\u0026n=0FFQLB-2pFQKMa2M\u0026q=85\u0026s=c21ce7ceeeaf3286e2d7153637741578"},"favicon":"https://mintcdn.com/govworx/qDX7OjQnRmbzD40w/images/gw_favicon.png?fit=max\u0026auto=format\u0026n=qDX7OjQnRmbzD40w\u0026q=85\u0026s=2bd89f34a56a030007368242536a11e4","navbar":{"links":[{"href":"https://support.govworx.net","label":"Support"}],"primary":{"type":"button","label":"Application Dashboard","href":"https://app.govworx.net"}},"footer":{},"banner":{"content":"Welcome to the GovWorx Beta API Documentation! Please reach out to support if you are interested in gaining access to the GovWorx API.","dismissible":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"About GovWorx","icon":"book-open-cover","href":"https://www.govworx.ai"},{"anchor":"Trust Center","icon":"lock","href":"https://security.govworx.ai"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"govworx","hasAudioNarration":false,"actualSubdomain":"govworx","customDomains":["developers.govworx.ai"],"gitSource":{"type":"github","owner":"psco-tech","repo":"gw-api-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae2b7aeb7812a2f5f9bc0df","collectionId":"fa2f4a63-0021-4d48-841b-419314e96c4e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae2b7aeb7812a2f5f9bc0df"},"entitlements":{},"buildId":"6ae2b7aeb7812a2f5f9bc0df","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API reference","count":53},{"language":"default","tag":"API Reference","count":31},{"language":"default","tag":"Connections Platform","count":22},{"language":"default","tag":"Realtime API Reference","count":21},{"language":"default","tag":"MCP Resources","count":10},{"language":"default","tag":"CAD integration","count":9},{"language":"default","tag":"Testing","count":8},{"language":"default","tag":"Test Calls","count":8},{"language":"default","tag":"Realtime Calls","count":7},{"language":"default","tag":"capture-radio-controller","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"connections-platform/test-calls/api-reference/test-calls/get-test-call-status","slug":"/connections-platform/test-calls/api-reference/test-calls/get-test-call-status","pageMetadata":{"title":"Get test-call status","description":"Read the retained recording receipt and refresh nonterminal simulator progress. A terminal Failed or Cancelled receipt is returned as HTTP 200 with that state; during failure publication a nonterminal refresh can temporarily return 503 instead. Unknown or unavailable cleanup is not confirmed termination. A fresh authorized token for the same tenant can read an existing receipt. No request body is required.","deprecated":null,"version":null,"playground":"simple","openapi":"/connections-platform/openapi/test-calls.json get /test-calls/v1/calls/{runId}","href":"/connections-platform/test-calls/api-reference/test-calls/get-test-call-status","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Read the retained recording receipt and refresh nonterminal simulator progress. A terminal Failed or Cancelled receipt is returned as HTTP 200 with that state; during failure publication a nonterminal refresh can temporarily return 503 instead. Unknown or unavailable cleanup is not confirmed termination. A fresh authorized token for the same tenant can read an existing receipt. No request body is required.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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 test-call status","description":"Read the retained recording receipt and refresh nonterminal simulator progress. A terminal Failed or Cancelled receipt is returned as HTTP 200 with that state; during failure publication a nonterminal refresh can temporarily return 503 instead. Unknown or unavailable cleanup is not confirmed termination. A fresh authorized token for the same tenant can read an existing receipt. No request body is required.","deprecated":null,"version":null,"playground":"simple","openapi":"/connections-platform/openapi/test-calls.json get /test-calls/v1/calls/{runId}","href":"/connections-platform/test-calls/api-reference/test-calls/get-test-call-status","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Test Calls"],"operationId":"getTestCall","x-mint":{"metadata":{"playground":"simple"}},"summary":"Get test-call status","description":"Read the retained recording receipt and refresh nonterminal simulator progress. A terminal Failed or Cancelled receipt is returned as HTTP 200 with that state; during failure publication a nonterminal refresh can temporarily return 503 instead. Unknown or unavailable cleanup is not confirmed termination. A fresh authorized token for the same tenant can read an existing receipt. No request body is required.","responses":{"200":"715129c2-456c-4398-80b9-0bd40f95f5d4","401":"fd1eaa6c-3d69-4f00-9343-c11037317669","403":"52ea0f08-10a2-46a2-b254-ff99bba4e1be","404":"5cc2f8f6-a477-48c3-8559-f4114240c91c","409":"7ffe7d55-2da8-411f-acd1-282323982f21","429":"62e76ef5-eb7d-425d-90c8-20b479506038","502":"54ee338e-a541-40f2-89ec-2ea0eff3c12a","503":"424aa8b0-b82e-4c62-8a1c-f3721eedd615"},"method":"get","type":"path","servers":["b277e79a-ec34-4343-a172-509a34ae550f","b821cad2-02fb-4d9b-8102-95bf87aa81fb","c40245a5-eb55-47a6-a147-cb4a8b263136"],"security":["dfce2fd2-dde2-444c-9cfb-3699b90a72de"],"path":"/test-calls/v1/calls/{runId}","baseUrlOptions":["https://api.gw-coach-sandbox.com","https://api.gw-coach-dev.com","https://api.govworx.net"],"title":"Get test-call status","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a18ce57a-f6d9-4306-93cc-038d27c068c0":{"name":"runId","in":"path","required":true,"description":"Opaque run ID returned by startcall. This is not requestId or recordingCallId.","schema":{"type":"string","pattern":"^[0-9a-fA-F]{64}$(?![\\s\\S])","minLength":64,"maxLength":64,"isRequired":true,"description":"Opaque run ID returned by startcall. This is not requestId or recordingCallId.","uniqueKey":"","typeLabel":"string"}}},"responses":{"715129c2-456c-4398-80b9-0bd40f95f5d4":{"description":"Current retained recording status, including terminal failure/cancellation.","content":{"application/json":{"schema":{"type":"object","required":["runId","tenantIdentifier","stationId","state","createdAt","expiresAt","recordingCallId","locationSent","error"],"properties":{"runId":{"type":"string","pattern":"^[0-9a-f]{64}$(?![\\s\\S])","isRequired":true,"uniqueKey":"runId","typeLabel":"string"},"tenantIdentifier":{"type":"string","description":"Trusted tenant identity from the token, not a caller-selected route.","isRequired":true,"uniqueKey":"tenantIdentifier","typeLabel":"string"},"stationId":{"type":"string","isRequired":true,"uniqueKey":"stationId","typeLabel":"string"},"state":{"type":"string","enum":["Dispatching","Unknown","Accepted","Running","Completed","Failed","Cancelled"],"description":"Simulator state only. Completed means recording cleanup was confirmed, not that Assist/backend delivery occurred. Unknown requires reconciliation, not a new request to bypass admission.","isRequired":true,"uniqueKey":"state","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"expiresAt":{"type":"string","format":"date-time","description":"Receipt expiry, not scheduled call-end time. Terminal history can be evicted earlier.","isRequired":true,"uniqueKey":"expiresAt","typeLabel":"string\u003cdate-time>"},"recordingCallId":{"oneOf":[{"type":"string","description":"SIP recording-session identifier for support correlation; not the API runId or the backend call ID.","isRequired":true,"uniqueKey":"recordingCallId.oneOf.0","typeLabel":"string"},{"type":"null","description":"SIP recording-session identifier for support correlation; not the API runId or the backend call ID.","isRequired":true,"uniqueKey":"recordingCallId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"recordingCallId","typeLabel":"string | null"},"locationSent":{"oneOf":[{"type":"boolean","description":"True: all records written to TCP. False: at least one failed attempt. Null: no failure observed but no location requested or not all records sent. None of these proves Location parsing/correlation/backend delivery.","isRequired":true,"uniqueKey":"locationSent.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True: all records written to TCP. False: at least one failed attempt. Null: no failure observed but no location requested or not all records sent. None of these proves Location parsing/correlation/backend delivery.","isRequired":true,"uniqueKey":"locationSent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"locationSent","typeLabel":"boolean | null"},"error":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error","typeLabel":"string | null"},"locationProgress":{"type":"object","required":["total","attempted","sent","stopReason"],"properties":{"total":{"type":"integer","minimum":1,"maximum":50,"isRequired":true,"uniqueKey":"locationProgress.total","typeLabel":"integer"},"attempted":{"type":"integer","minimum":0,"maximum":50,"description":"Durable send claims; may include an attempt suppressed before TCP write.","isRequired":true,"uniqueKey":"locationProgress.attempted","typeLabel":"integer"},"sent":{"type":"integer","minimum":0,"maximum":50,"description":"TCP writes with durably recorded success, not confirmed downstream location updates.","isRequired":true,"uniqueKey":"locationProgress.sent","typeLabel":"integer"},"stopReason":{"oneOf":[{"type":"string","description":"Null while pending; known outcomes include all_sent, send_failed, call_ended, scenario_completed, cancelled, peer_ended, recovery and execution_interrupted.","isRequired":true,"uniqueKey":"locationProgress.stopReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Null while pending; known outcomes include all_sent, send_failed, call_ended, scenario_completed, cancelled, peer_ended, recovery and execution_interrupted.","isRequired":true,"uniqueKey":"locationProgress.stopReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"locationProgress.stopReason","typeLabel":"string | null"}},"description":"Optional enrichment when matching execution progress is available. May be absent even for location requests.","uniqueKey":"locationProgress","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"runId":"\u003cstring>","tenantIdentifier":"\u003cstring>","stationId":"\u003cstring>","state":"Dispatching","createdAt":"2023-11-07T05:31:56Z","expiresAt":"2023-11-07T05:31:56Z","recordingCallId":"\u003cstring>","locationSent":true,"error":"\u003cstring>","locationProgress":{"total":25,"attempted":25,"sent":25,"stopReason":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"fd1eaa6c-3d69-4f00-9343-c11037317669":{"description":"Missing, invalid, expired or wrong-environment Test Calls access token. The response can have an empty body. Exchange a Coach API key at the token endpoint and retry with the returned access_token.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"52ea0f08-10a2-46a2-b254-ff99bba4e1be":{"description":"Tenant authority or route does not match.","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"runId":{"oneOf":[{"type":"string","description":"Present when a run is known; can be null or absent for pre-admission failures.","uniqueKey":"runId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Present when a run is known; can be null or absent for pre-admission failures.","uniqueKey":"runId.oneOf.1","typeLabel":"null"}],"uniqueKey":"runId","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":"tenant_forbidden","runId":null},"examples":{"Example":{"title":"Example","value":{"code":"tenant_forbidden","runId":null}}},"exampleType":"examples"}},"exampleType":"examples"},"5cc2f8f6-a477-48c3-8559-f4114240c91c":{"description":"Malformed/unknown run ID, expired/evicted receipt, or receipt belonging to another tenant.","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"runId":{"oneOf":[{"type":"string","description":"Present when a run is known; can be null or absent for pre-admission failures.","uniqueKey":"runId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Present when a run is known; can be null or absent for pre-admission failures.","uniqueKey":"runId.oneOf.1","typeLabel":"null"}],"uniqueKey":"runId","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":"run_not_found","runId":null},"examples":{"Example":{"title":"Example","value":{"code":"run_not_found","runId":null}}},"exampleType":"examples"}},"exampleType":"examples"},"7ffe7d55-2da8-411f-acd1-282323982f21":{"description":"Another request holds the run lock. Retry the same operation after a short delay.","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"runId":{"oneOf":[{"type":"string","description":"Present when a run is known; can be null or absent for pre-admission failures.","uniqueKey":"runId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Present when a run is known; can be null or absent for pre-admission failures.","uniqueKey":"runId.oneOf.1","typeLabel":"null"}],"uniqueKey":"runId","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","runId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"62e76ef5-eb7d-425d-90c8-20b479506038":{"description":"Rate, pause, concurrency or safe storage admission limit. Application codes include tenant_start_rate_limited, global_start_rate_limited, calls_paused, station_busy, target_busy, global_calls_busy, tenant_run_capacity and run_capacity. Some pre-authentication/endpoint limiters return an empty body. Honor Retry-After when present. Do not bypass station_busy using another request ID: an earlier active/uncertain recording may still exist.","headers":{"Retry-After":{"description":"Seconds until retry when supplied; not guaranteed for every 429.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"runId":{"oneOf":[{"type":"string","description":"Present when a run is known; can be null or absent for pre-admission failures.","uniqueKey":"runId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Present when a run is known; can be null or absent for pre-admission failures.","uniqueKey":"runId.oneOf.1","typeLabel":"null"}],"uniqueKey":"runId","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","runId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"54ee338e-a541-40f2-89ec-2ea0eff3c12a":{"description":"The simulator refresh could not be safely applied. Keep the run ID for investigation.","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"runId":{"oneOf":[{"type":"string","description":"Present when a run is known; can be null or absent for pre-admission failures.","uniqueKey":"runId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Present when a run is known; can be null or absent for pre-admission failures.","uniqueKey":"runId.oneOf.1","typeLabel":"null"}],"uniqueKey":"runId","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","runId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"424aa8b0-b82e-4c62-8a1c-f3721eedd615":{"description":"Dependency/simulator/audio unavailable or outcome uncertain. Codes include dependency_unavailable, simulator_not_configured, simulator_unavailable, audio_not_configured, audio_generation_failed, simulation_uncertain, cleanup_uncertain, admission_index_rebuilding and run_state_unavailable. A returned runId should be retained for status/cancel/support. An uncertain response does not prove no recording was created; do not blindly start another call.","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"runId":{"oneOf":[{"type":"string","description":"Present when a run is known; can be null or absent for pre-admission failures.","uniqueKey":"runId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Present when a run is known; can be null or absent for pre-admission failures.","uniqueKey":"runId.oneOf.1","typeLabel":"null"}],"uniqueKey":"runId","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","runId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"dfce2fd2-dde2-444c-9cfb-3699b90a72de":{"TestCallAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"One-hour access_token returned by the same environment's token endpoint. Never use a token from another environment.","scopes":[],"schemeName":"TestCallAccessToken"}}},"servers":{"b277e79a-ec34-4343-a172-509a34ae550f":{"url":"https://api.gw-coach-sandbox.com","description":"Sandbox — start here"},"b821cad2-02fb-4d9b-8102-95bf87aa81fb":{"url":"https://api.gw-coach-dev.com","description":"Development"},"c40245a5-eb55-47a6-a147-cb4a8b263136":{"url":"https://api.govworx.net","description":"Production — creates normal records"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"One-hour access_token returned by the same environment's token endpoint. Never use a token from another environment.","scopes":[],"schemeName":"TestCallAccessToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"One-hour access_token returned by the same environment's token endpoint. Never use a token from another environment.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"TestCallAccessToken","name":"Authorization"}],"title":"TestCallAccessToken"}]},"originalFileLocation":"connections-platform/openapi/test-calls.json"},"subdomain":"govworx","siteName":"GovWorx API Documentation","title":"Get test-call status - GovWorx API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T00:35:54.612Z","originalFileLocation":"connections-platform/test-calls/api-reference/test-calls/get-test-call-status.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=\"description\" content=\"Read the retained recording receipt and refresh nonterminal simulator progress. A terminal Failed or Cancelled receipt is returned as HTTP 200 with that state; during failure publication a nonterminal refresh can temporarily return 503 instead. Unknown or unavailable cleanup is not confirmed termination. A fresh authorized token for the same tenant can read an existing receipt. No request body is required.\">\u003cmeta data-mint-head name=\"application-name\" content=\"GovWorx API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/govworx/LV4nt-UNetYIjxXN/_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/govworx/LV4nt-UNetYIjxXN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/govworx/LV4nt-UNetYIjxXN/_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/govworx/LV4nt-UNetYIjxXN/_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/govworx/LV4nt-UNetYIjxXN/_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/govworx/LV4nt-UNetYIjxXN/_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/govworx/LV4nt-UNetYIjxXN/_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/govworx/LV4nt-UNetYIjxXN/_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/govworx/LV4nt-UNetYIjxXN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get test-call status - GovWorx API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Read the retained recording receipt and refresh nonterminal simulator progress. A terminal Failed or Cancelled receipt is returned as HTTP 200 with that state; during failure publication a nonterminal refresh can temporarily return 503 instead. Unknown or unavailable cleanup is not confirmed termination. A fresh authorized token for the same tenant can read an existing receipt. No request body is required.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"GovWorx API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.govworx.ai/connections-platform/test-calls/api-reference/test-calls/get-test-call-status\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://govworx.mintlify.app/_mintlify/api/og/v2?division=Test+Calls\u0026amp;title=Get+test-call+status\u0026amp;description=Read+the+retained+recording+receipt+and+refresh+nonterminal+simulator+progress.+A+terminal+Failed+or+Cancelled+receipt+is+returned+as+HTTP+200+with+that+state%3B+\u0026amp;theme=9ed98ad7a71cea6ade40e8a5\u0026amp;signature=cf439b8a158dfa3781498a99a2a1d8f2bfc17c5b4d199158c44b0109728bcf38\">\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 test-call status - GovWorx API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Read the retained recording receipt and refresh nonterminal simulator progress. A terminal Failed or Cancelled receipt is returned as HTTP 200 with that state; during failure publication a nonterminal refresh can temporarily return 503 instead. Unknown or unavailable cleanup is not confirmed termination. A fresh authorized token for the same tenant can read an existing receipt. No request body is required.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://govworx.mintlify.app/_mintlify/api/og/v2?division=Test+Calls\u0026amp;title=Get+test-call+status\u0026amp;description=Read+the+retained+recording+receipt+and+refresh+nonterminal+simulator+progress.+A+terminal+Failed+or+Cancelled+receipt+is+returned+as+HTTP+200+with+that+state%3B+\u0026amp;theme=9ed98ad7a71cea6ade40e8a5\u0026amp;signature=cf439b8a158dfa3781498a99a2a1d8f2bfc17c5b4d199158c44b0109728bcf38\">\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/govworx/LV4nt-UNetYIjxXN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"GovWorx API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#339af0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.govworx.ai/connections-platform/test-calls/api-reference/test-calls/get-test-call-status\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/connections-platform/test-calls/api-reference/test-calls/get-test-call-status.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.govworx.ai/#organization\",\"name\":\"GovWorx API Documentation\",\"url\":\"https://developers.govworx.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/govworx/0FFQLB-2pFQKMa2M/logo/GovWorx-Logo_light.png?fit=max\u0026auto=format\u0026n=0FFQLB-2pFQKMa2M\u0026q=85\u0026s=6f689d9f51a89e59482167234491c4ee\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.govworx.ai#website\",\"name\":\"GovWorx API Documentation\",\"url\":\"https://developers.govworx.ai\",\"publisher\":{\"@id\":\"https://developers.govworx.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.govworx.ai/connections-platform/test-calls/api-reference/test-calls/get-test-call-status#webpage\",\"url\":\"https://developers.govworx.ai/connections-platform/test-calls/api-reference/test-calls/get-test-call-status\",\"name\":\"Get test-call status\",\"description\":\"Read the retained recording receipt and refresh nonterminal simulator progress. A terminal Failed or Cancelled receipt is returned as HTTP 200 with that state; during failure publication a nonterminal refresh can temporarily return 503 instead. Unknown or unavailable cleanup is not confirmed termination. A fresh authorized token for the same tenant can read an existing receipt. No request body is required.\",\"dateModified\":\"2026-10-29T00:35:54.612Z\",\"isPartOf\":{\"@id\":\"https://developers.govworx.ai#website\"},\"breadcrumb\":{\"@id\":\"https://developers.govworx.ai/connections-platform/test-calls/api-reference/test-calls/get-test-call-status#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.govworx.ai/connections-platform/test-calls/api-reference/test-calls/get-test-call-status#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Testing\",\"item\":\"https://developers.govworx.ai/connections-platform/test-calls/quickstart\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Test Calls\",\"item\":\"https://developers.govworx.ai/connections-platform/test-calls/quickstart\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get test-call status\",\"item\":\"https://developers.govworx.ai/connections-platform/test-calls/api-reference/test-calls/get-test-call-status\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.govworx.ai/connections-platform/test-calls/api-reference/test-calls/get-test-call-status#apireference\",\"headline\":\"Get test-call status\",\"name\":\"Get test-call status\",\"description\":\"Read the retained recording receipt and refresh nonterminal simulator progress. A terminal Failed or Cancelled receipt is returned as HTTP 200 with that state; during failure publication a nonterminal refresh can temporarily return 503 instead. Unknown or unavailable cleanup is not confirmed termination. A fresh authorized token for the same tenant can read an existing receipt. No request body is required.\",\"url\":\"https://developers.govworx.ai/connections-platform/test-calls/api-reference/test-calls/get-test-call-status\",\"mainEntityOfPage\":{\"@id\":\"https://developers.govworx.ai/connections-platform/test-calls/api-reference/test-calls/get-test-call-status#webpage\"},\"dateModified\":\"2026-10-29T00:35:54.612Z\",\"publisher\":{\"@id\":\"https://developers.govworx.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.govworx.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"GovWorx API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"GovWorx API Documentation","nav":{"global":{"anchors":[{"anchor":"About GovWorx","icon":"book-open-cover","href":"https://www.govworx.ai"},{"anchor":"Trust Center","icon":"lock","href":"https://security.govworx.ai"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Connections Platform","groups":[{"group":"CAD integration","pages":[{"title":"Connections Platform","href":"/connections-platform/overview"},{"title":"CAD integration","href":"/connections-platform/cad-integration-guide"},{"title":"Send incident events","href":"/connections-platform/inbound-incidents"},{"title":"Create a CAD incident","href":"/connections-platform/create-cad-incident"},{"title":"Receive incident updates from GovWorx","href":"/connections-platform/outbound-interactions"},{"title":"Authentication","href":"/connections-platform/authentication"},{"title":"NENA EIDO incident events","href":"/connections-platform/nena-eido"},{"title":"Reliability and delivery identity","href":"/connections-platform/reliability"},{"title":"Connector profiles","href":"/connections-platform/connector-profiles"}]},{"group":"CAD API reference","pages":[{"group":"Send incidents to GovWorx","pages":[{"title":"Publish an incident event","deprecated":null,"version":null,"openapi":"/connections-platform/openapi/cad.yaml post /cad/v1/incidents","href":"/connections-platform/api-reference/send-incidents-to-govworx/publish-an-incident-event"}]},{"group":"Receive incident updates from GovWorx","pages":[{"title":"Receive a call type update","version":null,"deprecated":null,"openapi":"/connections-platform/openapi/cad.yaml webhook callType","href":"/connections-platform/api-reference/receive-incident-updates-from-govworx/receive-a-call-type-update"},{"title":"Receive a comment update","version":null,"deprecated":null,"openapi":"/connections-platform/openapi/cad.yaml webhook comment","href":"/connections-platform/api-reference/receive-incident-updates-from-govworx/receive-a-comment-update"},{"title":"Receive a dispatch update","version":null,"deprecated":null,"openapi":"/connections-platform/openapi/cad.yaml webhook dispatch","href":"/connections-platform/api-reference/receive-incident-updates-from-govworx/receive-a-dispatch-update"},{"title":"Receive a completed interaction","version":null,"deprecated":null,"openapi":"/connections-platform/openapi/cad.yaml webhook completed","href":"/connections-platform/api-reference/receive-incident-updates-from-govworx/receive-a-completed-interaction"}]}]},{"group":"Testing","pages":[{"group":"Test Calls","expanded":false,"pages":[{"title":"Test Calls quickstart","href":"/connections-platform/test-calls/quickstart"},{"title":"Audio scenarios and languages","href":"/connections-platform/test-calls/audio-scenarios"},{"title":"Location updates","href":"/connections-platform/test-calls/locations"},{"title":"Lifecycle, limits and troubleshooting","href":"/connections-platform/test-calls/lifecycle-and-errors"},{"title":"Exchange a Coach API key","deprecated":null,"version":null,"playground":"simple","openapi":"/connections-platform/openapi/test-calls.json post /test-calls/v1/token","href":"/connections-platform/test-calls/api-reference/test-calls/exchange-a-coach-api-key"},{"title":"Start a test call","description":"Generate a recording for a configured test station and mock ANI. Only stationId and phoneNumber are required; audio defaults off and the call maximum defaults to 60 seconds. Audio ends after one scenario or at that maximum, whichever comes first. For retry protection, generate and retain a unique requestId before the first POST, then reuse that ID and unchanged payload for retries. Omit it only for one-off requests without automatic retries: the generated requestId is not returned, so a lost response cannot be safely retried. A retained replay starts no new recording. Results describe the simulator, not confirmed Assist delivery. The complete UTF-8 JSON body is limited to 8192 bytes; unknown fields are rejected.","deprecated":null,"version":null,"playground":"simple","openapi":"/connections-platform/openapi/test-calls.json post /test-calls/v1/startcall","href":"/connections-platform/test-calls/api-reference/test-calls/start-a-test-call"},{"title":"Get test-call status","deprecated":null,"version":null,"playground":"simple","openapi":"/connections-platform/openapi/test-calls.json get /test-calls/v1/calls/{runId}","href":"/connections-platform/test-calls/api-reference/test-calls/get-test-call-status"},{"title":"Cancel a test call","description":"Request shutdown of this tenant's recording, with no request body. A Cancelled result confirms cleanup; Running or Unknown does not. A terminal receipt is returned unchanged, so cancelling Completed does not change it to Cancelled. Do not create new request IDs to bypass an uncertain recording or a station_busy reservation. Cancellation does not revoke the access token.","deprecated":null,"version":null,"playground":"simple","openapi":"/connections-platform/openapi/test-calls.json post /test-calls/v1/calls/{runId}/cancel","href":"/connections-platform/test-calls/api-reference/test-calls/cancel-a-test-call"}]}]}]},{"tab":"API reference","pages":[{"title":"API reference","href":"/api-reference/introduction"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp-tools"}]}]},"basePath":"","title":"Get test-call status - GovWorx API Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}