api/documentation/topics/generated/birdTestOutboundVoiceCall.topic

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
        SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
       title="Place a test outbound call and hang up when accepted" id="birdTestOutboundVoiceCall">

    <!-- AUTO-GENERATED, DO NOT EDIT -->
    <p>This endpoint documentation is generated directly from <code>openapi.yaml</code>.</p>
    <chapter title="Endpoint" id="endpoint">
        <code-block lang="http">POST /bird/voice/calls/test-outbound</code-block>
    </chapter>
    <chapter title="Operation" id="operation">
        <p>Operation ID: <code>birdTestOutboundVoiceCall</code></p>
        <p>Calls +45 42 33 11 28 and hangs up when the call reaches accepted/ongoing state.</p>
    </chapter>
    <chapter title="Authentication" id="authentication">
        <p>Security requirements:</p>
        <table>
            <tr><td>Scheme</td><td>Scopes</td></tr>
            <tr><td>BearerAuth</td><td>-</td></tr>
        </table>
    </chapter>
    <chapter title="Parameters" id="parameters">
        <table>
            <tr><td>Name</td><td>In</td><td>Required</td><td>Type</td><td>Description</td></tr>
            <tr><td>workspaceId</td><td>query</td><td>no</td><td>string</td><td>Bird Workspace identifier (falls back to module configuration if omitted)</td></tr>
            <tr><td>channelId</td><td>query</td><td>no</td><td>string</td><td>Bird Channel identifier (falls back to module configuration if omitted)</td></tr>
        </table>
    </chapter>
    <chapter title="Request Body" id="request-body">
        <p>Required: no.</p>
        <p>Content type: <code>application/json</code></p>
        <code-block lang="json">
{
  &quot;additionalProperties&quot;: true,
  &quot;properties&quot;: {
    &quot;from&quot;: {
      &quot;description&quot;: &quot;Caller E.164 number to use for the test call&quot;,
      &quot;example&quot;: &quot;+4599988877&quot;,
      &quot;type&quot;: &quot;string&quot;
    },
    &quot;hangupCause&quot;: {
      &quot;description&quot;: &quot;Optional hangup cause passed through to Bird&quot;,
      &quot;type&quot;: &quot;string&quot;
    },
    &quot;maxPollSeconds&quot;: {
      &quot;description&quot;: &quot;Max time to wait before timing out&quot;,
      &quot;example&quot;: 30,
      &quot;minimum&quot;: 5,
      &quot;type&quot;: &quot;integer&quot;
    },
    &quot;pollIntervalSeconds&quot;: {
      &quot;description&quot;: &quot;Poll interval while waiting for accepted status&quot;,
      &quot;example&quot;: 2,
      &quot;minimum&quot;: 1,
      &quot;type&quot;: &quot;integer&quot;
    }
  },
  &quot;type&quot;: &quot;object&quot;
}
        </code-block>
    </chapter>
    <chapter title="Responses" id="responses">
        <table>
            <tr><td>Status</td><td>Description</td><td>Content Types</td></tr>
            <tr><td>200</td><td>Test call created and either hung up or timed out</td><td>application/json</td></tr>
        </table>
        <p>Schema for response <code>200</code> (<code>application/json</code>):</p>
        <code-block lang="json">
{
  &quot;$ref&quot;: &quot;#/components/schemas/BirdTestOutboundCallResponse&quot;
}
        </code-block>
    </chapter>
</topic>