Meeting Session Actions

Speak in a meeting session

Changed on

Sends audio / text-to-speech into a meeting session. With a Telnyx AI Assistant attached, the bot is a webpage-output bot: the speak audio routes through the assistant's output page rather than the bot mic and plays once the assistant is connected -- it is not refused. If that page cannot be reached, delivery fails with the 502 below, which may arrive without an error envelope, so branch on the status code before parsing a body. The assistant is designed to own the conversation, so prefer letting it speak or use send_chat. With a digital avatar (assistant.avatar: true), speak is refused with 409 invalid_state (message prefix avatar_requires_assistant_speech:): the avatar renders only the assistant's own speech.

post/meeting_sessions/{id}/actions/speak

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/meeting_sessions/{id}/actions/speak
  • Auth: HTTP bearer

Path parameters

idstring required
Example:mtgsess_a1b2c3d4-e5f6-7890-abcd-ef1234567890

Unique identifier for the meeting session.

Request body

textstring required

Text for the bot to speak.

voicestring

Voice identifier to use for this utterance. When supplied, it overrides the session-default voice configured at creation; otherwise the speak action uses that session default.

interruptboolean

If true, interrupt any currently playing audio to speak this text immediately.

Response

The speak action was accepted and is being processed.

Example response

{
  "data": {
    "accepted": true
  }
}

Changes