Vobiz Logo
Vobiz
|API Documentation
Console
← Back to Members

Speak Text to a Member

Convert text to speech and play it to specific conference members using TTS technology.

This API allows you to send text that will be converted to speech and played to one or more members of a conference. Only the specified members will hear the synthesized speech.

Authentication Required:

  • • X-Auth-ID: Your account ID (e.g., {Auth_ID})
  • • X-Auth-Token: Your account Auth Token
  • • Content-Type: application/json

Privacy: The text-to-speech audio is played exclusively to the targeted member(s). Other conference participants will not hear the synthesized speech.

TTS Customization: You can customize voice, language, and speed using optional parameters.

HTTP Request

POSThttps://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Speak/

The member_id can be: a specific member_id, comma-separated list, or "all" to speak text to all members.

Request Parameters

Request Parameters

NameTypeDescription
textRequired
stringText to be converted to speech and played to the member(s). Maximum 1000 characters.
voice
stringVoice to use for TTS. Options: WOMAN, MAN. Default: WOMAN.
language
stringLanguage code for TTS. Example: en-US, es-ES. Default: en-US.

Response

Response - 200 OK
{
  "message": "speak started",
  "api_id": "9c7fb3c6-58c4-11e1-86da-adf28403fe48",
  "member_id": ["10"]
}

Examples

Speak Text to Specific Member

cURL Request
curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/MyConf/Member/10/Speak/ \
                  -H "X-Auth-ID: YOUR_AUTH_ID" \
                  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
                  -H "Content-Type: application/json" \
                  -d '{"text":"Welcome to the conference. Please wait while we connect you."}'

Speak Text with Custom Voice

cURL Request
curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/MyConf/Member/10/Speak/ \
                  -H "X-Auth-ID: YOUR_AUTH_ID" \
                  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
                  -H "Content-Type: application/json" \
                  -d '{"text":"Thank you for joining.","voice":"MAN","language":"en-US"}'

Speak Text to All Members

cURL Request
curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/MyConf/Member/all/Speak/ \
                  -H "X-Auth-ID: YOUR_AUTH_ID" \
                  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
                  -H "Content-Type: application/json" \
                  -d '{"text":"This conference will begin in 2 minutes."}'

Common Use Cases:

  • • Welcome messages for new participants
  • • Dynamic announcements based on conference state
  • • Instructions or prompts during the conference
  • • Real-time notifications and alerts
Stop Playing Audio to a Member
Stop Speaking Text to a Member