api/documentation/topics/generated/birdSayOnVoiceCall.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="Say a message on an active voice call and hang up afterwards" id="birdSayOnVoiceCall">

    <!-- 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/{id}/say</code-block>
    </chapter>
    <chapter title="Operation" id="operation">
        <p>Operation ID: <code>birdSayOnVoiceCall</code></p>
        <p>Say a message on an active voice call and hang up afterwards</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>Call identifier</td></tr>
        </table>
    </chapter>
    <chapter title="Request Body" id="request-body">
        <p>Required: yes.</p>
        <p>Content type: <code>application/json</code></p>
        <code-block lang="json">
{
  &quot;properties&quot;: {
    &quot;hangup&quot;: {
      &quot;description&quot;: &quot;Whether to hang up the call after the message finishes playing (defaults to true)&quot;,
      &quot;example&quot;: true,
      &quot;type&quot;: &quot;boolean&quot;
    },
    &quot;locale&quot;: {
      &quot;description&quot;: &quot;The locale to use for the TTS voice (e.g. en-US)&quot;,
      &quot;example&quot;: &quot;en-US&quot;,
      &quot;type&quot;: &quot;string&quot;
    },
    &quot;loop&quot;: {
      &quot;description&quot;: &quot;Number of times to loop the message&quot;,
      &quot;example&quot;: 1,
      &quot;type&quot;: &quot;integer&quot;
    },
    &quot;text&quot;: {
      &quot;description&quot;: &quot;The text message to play via TTS&quot;,
      &quot;example&quot;: &quot;The gate will open shortly.&quot;,
      &quot;type&quot;: &quot;string&quot;
    },
    &quot;timeout&quot;: {
      &quot;description&quot;: &quot;Timeout in seconds for the TTS action&quot;,
      &quot;example&quot;: 1,
      &quot;type&quot;: &quot;integer&quot;
    },
    &quot;voice&quot;: {
      &quot;description&quot;: &quot;The voice identifier to use&quot;,
      &quot;example&quot;: &quot;male&quot;,
      &quot;type&quot;: &quot;string&quot;
    }
  },
  &quot;required&quot;: [
    &quot;text&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>TTS action requested</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/BirdVoiceCallSingleResponse&quot;
}
        </code-block>
    </chapter>
</topic>