46 lines
2.1 KiB
XML
46 lines
2.1 KiB
XML
<?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="Get a flash call by ID" id="birdGetFlashCall">
|
|
|
|
<!-- 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">GET /bird/voice/flash-calls/{id}</code-block>
|
|
</chapter>
|
|
<chapter title="Operation" id="operation">
|
|
<p>Operation ID: <code>birdGetFlashCall</code></p>
|
|
<p>Get a flash call by ID</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>
|
|
<tr><td>id</td><td>path</td><td>yes</td><td>string</td><td></td></tr>
|
|
</table>
|
|
</chapter>
|
|
<chapter title="Responses" id="responses">
|
|
<table>
|
|
<tr><td>Status</td><td>Description</td><td>Content Types</td></tr>
|
|
<tr><td>200</td><td>Flash call details</td><td>application/json</td></tr>
|
|
</table>
|
|
<p>Schema for response <code>200</code> (<code>application/json</code>):</p>
|
|
<code-block lang="json">
|
|
{
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
</code-block>
|
|
</chapter>
|
|
</topic>
|