Say a message on an active voice call and hang up afterwards

This endpoint documentation is generated directly from openapi.yaml.

Endpoint

POST /bird/voice/calls/{id}/say

Operation

Operation ID: birdSayOnVoiceCall

Say a message on an active voice call and hang up afterwards

Authentication

Security requirements:

Scheme	Scopes
BearerAuth	-

Parameters

Name	In	Required	Type	Description
workspaceId	query	no	string	Bird Workspace identifier (falls back to module configuration if omitted)
channelId	query	no	string	Bird Channel identifier (falls back to module configuration if omitted)
id	path	yes	string	Call identifier

Request Body

Required: yes.

Content type: application/json

{
  "properties": {
    "hangup": {
      "description": "Whether to hang up the call after the message finishes playing (defaults to true)",
      "example": true,
      "type": "boolean"
    },
    "locale": {
      "description": "The locale to use for the TTS voice (e.g. en-US)",
      "example": "en-US",
      "type": "string"
    },
    "loop": {
      "description": "Number of times to loop the message",
      "example": 1,
      "type": "integer"
    },
    "text": {
      "description": "The text message to play via TTS",
      "example": "The gate will open shortly.",
      "type": "string"
    },
    "timeout": {
      "description": "Timeout in seconds for the TTS action",
      "example": 1,
      "type": "integer"
    },
    "voice": {
      "description": "The voice identifier to use",
      "example": "male",
      "type": "string"
    }
  },
  "required": [
    "text"
  ],
  "type": "object"
}
        

Responses

Status	Description	Content Types
200	TTS action requested	application/json

Schema for response 200 (application/json):

{
  "$ref": "#/components/schemas/BirdVoiceCallSingleResponse"
}
        

17 March 2026