Say Text-To-Speech (TTS)
Use this request in order to say
a text message during a call, this API uses our Text-To-Speech service to convert the provided text into an audio, you can configure the text, language, voice nature and if you want the message to repeat.
Say TTS into a channel call
Authorizations
Path parameters
workspaceIdstring · uuidRequired
The ID of the workspace
callIdstring · uuidRequired
The ID for a call
channelIdstring · uuidRequired
The ID for a channel
Body
textstringRequired
localestring · enumOptionalDefault:
en-US
Example: en-US
Possible values: voicestringOptional
loopintegerOptional
timeoutintegerOptional
Responses
202
Call Command Say was accepted for processing
application/json
400
The request did not pass validation
application/json
404
The request did not pass validation
application/json
422
The request did not pass validation
application/json
post
POST /workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/say HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68
{
"text": "text",
"locale": "en-US",
"voice": "text",
"loop": 1,
"timeout": 1
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"callId": "123e4567-e89b-12d3-a456-426614174000",
"callFlowId": "123e4567-e89b-12d3-a456-426614174000",
"status": "text",
"command": "text",
"conditions": [
{
"variable": "keys",
"operator": "eq",
"value": "text"
}
]
}
Example 1: Play an announcement when an outbound call is running
curl -X POST "https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/say" \
-H "Authorization: AccessKey YOUR_SECRET_TOKEN"
Last updated
Was this helpful?