48 lines
8.8 KiB
HTML
48 lines
8.8 KiB
HTML
<!DOCTYPE html SYSTEM "about:legacy-compat">
|
|
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"><meta name="built-on" content="2026-03-17T15:42:14.677040207"><title>Place a test outbound call and hang up when accepted | Copenhagen Truck Wash API</title><script type="application/json" id="virtual-toc-data">[{"id":"endpoint","level":0,"title":"Endpoint","anchor":"#endpoint"},{"id":"operation","level":0,"title":"Operation","anchor":"#operation"},{"id":"authentication","level":0,"title":"Authentication","anchor":"#authentication"},{"id":"parameters","level":0,"title":"Parameters","anchor":"#parameters"},{"id":"request-body","level":0,"title":"Request Body","anchor":"#request-body"},{"id":"responses","level":0,"title":"Responses","anchor":"#responses"}]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.26.0-b913/app.css" rel="stylesheet"><meta name="msapplication-TileColor" content="#000000"><link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Place a test outbound call and hang up when accepted | Copenhagen Truck Wash API"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Copenhagen Truck Wash API Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/birdtestoutboundvoicecall.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Place a test outbound call and hang up when accepted | Copenhagen Truck Wash API"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
|
|
"@context": "http://schema.org",
|
|
"@type": "WebPage",
|
|
"@id": "writerside-documentation/birdtestoutboundvoicecall.html#webpage",
|
|
"url": "writerside-documentation/birdtestoutboundvoicecall.html",
|
|
"name": "Place a test outbound call and hang up when accepted | Copenhagen Truck Wash API",
|
|
"description": "",
|
|
"image": "",
|
|
"inLanguage":"en-US"
|
|
}</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json">{
|
|
"@type": "WebSite",
|
|
"@id": "writerside-documentation/#website",
|
|
"url": "writerside-documentation/",
|
|
"name": "Copenhagen Truck Wash API Help"
|
|
}</script><!-- End Schema.org --></head><body data-id="birdTestOutboundVoiceCall" data-main-title="Place a test outbound call and hang up when accepted" data-article-props="{"seeAlsoStyle":"links"}" data-template="article" data-breadcrumbs="API-Reference.topic|API Reference///Tag_Bird.topic|Bird///Tag_Bird_Page_1.topic|Bird - Page 1 of 1"><div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Copenhagen Truck Wash API Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="birdTestOutboundVoiceCall" id="birdTestOutboundVoiceCall.topic">Place a test outbound call and hang up when accepted</h1><p id="-3ucdl_2">This endpoint documentation is generated directly from <code class="code" id="-3ucdl_9">openapi.yaml</code>.</p><section class="chapter"><h2 id="endpoint" data-toc="endpoint">Endpoint</h2><div class="code-block" data-lang="http">POST /bird/voice/calls/test-outbound</div></section><section class="chapter"><h2 id="operation" data-toc="operation">Operation</h2><p id="-3ucdl_11">Operation ID: <code class="code" id="-3ucdl_13">birdTestOutboundVoiceCall</code></p><p id="-3ucdl_12">Calls +45 42 33 11 28 and hangs up when the call reaches accepted/ongoing state.</p></section><section class="chapter"><h2 id="authentication" data-toc="authentication">Authentication</h2><p id="-3ucdl_14">Security requirements:</p><div class="table-wrapper"><table class="wide" id="-3ucdl_15"><thead><tr class="ijRowHead" id="-3ucdl_16"><th id="-3ucdl_18"><p>Scheme</p></th><th id="-3ucdl_19"><p>Scopes</p></th></tr></thead><tbody><tr id="-3ucdl_17"><td id="-3ucdl_20"><p>BearerAuth</p></td><td id="-3ucdl_21"><p>-</p></td></tr></tbody></table></div></section><section class="chapter"><h2 id="parameters" data-toc="parameters">Parameters</h2><div class="table-wrapper"><table class="wide" id="-3ucdl_22"><thead><tr class="ijRowHead" id="-3ucdl_23"><th id="-3ucdl_26"><p>Name</p></th><th id="-3ucdl_27"><p>In</p></th><th id="-3ucdl_28"><p>Required</p></th><th id="-3ucdl_29"><p>Type</p></th><th id="-3ucdl_30"><p>Description</p></th></tr></thead><tbody><tr id="-3ucdl_24"><td id="-3ucdl_31"><p>workspaceId</p></td><td id="-3ucdl_32"><p>query</p></td><td id="-3ucdl_33"><p>no</p></td><td id="-3ucdl_34"><p>string</p></td><td id="-3ucdl_35"><p>Bird Workspace identifier (falls back to module configuration if omitted)</p></td></tr><tr id="-3ucdl_25"><td id="-3ucdl_36"><p>channelId</p></td><td id="-3ucdl_37"><p>query</p></td><td id="-3ucdl_38"><p>no</p></td><td id="-3ucdl_39"><p>string</p></td><td id="-3ucdl_40"><p>Bird Channel identifier (falls back to module configuration if omitted)</p></td></tr></tbody></table></div></section><section class="chapter"><h2 id="request-body" data-toc="request-body">Request Body</h2><p id="-3ucdl_41">Required: no.</p><p id="-3ucdl_42">Content type: <code class="code" id="-3ucdl_44">application/json</code></p><div class="code-block" data-lang="json">
|
|
{
|
|
"additionalProperties": true,
|
|
"properties": {
|
|
"from": {
|
|
"description": "Caller E.164 number to use for the test call",
|
|
"example": "+4599988877",
|
|
"type": "string"
|
|
},
|
|
"hangupCause": {
|
|
"description": "Optional hangup cause passed through to Bird",
|
|
"type": "string"
|
|
},
|
|
"maxPollSeconds": {
|
|
"description": "Max time to wait before timing out",
|
|
"example": 30,
|
|
"minimum": 5,
|
|
"type": "integer"
|
|
},
|
|
"pollIntervalSeconds": {
|
|
"description": "Poll interval while waiting for accepted status",
|
|
"example": 2,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
</div></section><section class="chapter"><h2 id="responses" data-toc="responses">Responses</h2><div class="table-wrapper"><table class="wide" id="-3ucdl_45"><thead><tr class="ijRowHead" id="-3ucdl_48"><th id="-3ucdl_50"><p>Status</p></th><th id="-3ucdl_51"><p>Description</p></th><th id="-3ucdl_52"><p>Content Types</p></th></tr></thead><tbody><tr id="-3ucdl_49"><td id="-3ucdl_53"><p>200</p></td><td id="-3ucdl_54"><p>Test call created and either hung up or timed out</p></td><td id="-3ucdl_55"><p>application/json</p></td></tr></tbody></table></div><p id="-3ucdl_46">Schema for response <code class="code" id="-3ucdl_56">200</code> (<code class="code" id="-3ucdl_57">application/json</code>):</p><div class="code-block" data-lang="json">
|
|
{
|
|
"$ref": "#/components/schemas/BirdTestOutboundCallResponse"
|
|
}
|
|
</div></section><div class="last-modified">17 March 2026</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"><a href="birdcreatevoicecall.html" class="navigation-links__prev">Create/place a voice call via Bird</a><a href="birdgetvoicecall.html" class="navigation-links__next">Get a voice call by ID</a></div></article><div id="disqus_thread"></div></div></section></main></div><script src="https://resources.jetbrains.com/writerside/apidoc/6.26.0-b913/app.js"></script></body></html> |