Speaking

Send text to a speaking session

Adds text to the speech queue. Can be called multiple times.

post/speakings/{id}/say

Request

  • Base URL
    https://api.voipbin.net/v1.0
  • URL
    https://api.voipbin.net/v1.0/speakings/{id}/say
  • Auth
    none declared

Path parameters

idstring required

Request body

textstring required

Text to be spoken.

Response

The speaking session.

idstring uuid

The unique identifier of the speaking session. Returned from the POST /speakings or GET /speakings response.

customer_idstring uuid

The unique identifier of the customer who owns this speaking session. Returned from the GET /customers response.

reference_type'' | 'call' | 'confbridge'

Type of the referenced entity for the speaking session.

reference_idstring uuid

The unique identifier of the referenced resource (call or confbridge). Returned from the corresponding resource endpoint.

languagestring

TTS language (e.g. en-US)

providerstring

TTS provider (elevenlabs)

voice_idstring

Provider-specific voice ID

direction'' | 'in' | 'out' | 'both'

Audio injection direction for the speaking session.

status'initiating' | 'active' | 'stopped'

Status of the speaking session.

tm_createstring date-time

Creation timestamp

tm_updatestring date-time

Last update timestamp

tm_deletestring date-time

Soft-delete timestamp

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "reference_type": "call",
  "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "language": "en-US",
  "provider": "elevenlabs",
  "voice_id": "21m00Tcm4TlvDq8ikWAM",
  "direction": "both",
  "status": "active",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-16T14:20:00.000000Z",
  "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Changes

No recorded changes to this operation across all 111 revisions of this API.