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.

Command for say text to call

type: object
title: Say text to Call
additionalProperties: false
properties:
  text:
    type: string
  locale:
    type: string
    format: locale-bcp47
    default: en-US
    example:
      - en-US
    enum:
      - arb
      - ar-AE
      - ca-ES
      - yue-CN
      - cmn-CN
      - da-DK
      - nl-BE
      - nl-NL
      - en-AU
      - en-GB
      - en-IN
      - en-NZ
      - en-ZA
      - en-US
      - en-GB-WLS
      - fi-FI
      - fr-FR
      - fr-CA
      - hi-IN
      - de-DE
      - de-AT
      - is-IS
      - it-IT
      - ja-JP
      - ko-KR
      - nb-NO
      - pl-PL
      - pt-BR
      - pt-PT
      - ro-RO
      - ru-RU
      - es-ES
      - es-MX
      - es-US
      - sv-SE
      - tr-TR
      - cy-GB
  voice:
    type: string
    enum:
      - male
      - female
  loop:
    type: integer
  timeout:
    type: integer
required:
  - text

Say TTS

Say TTS into a channel call

POST/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/say

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

callId*string (uuid)

The ID for a call

channelId*string (uuid)

The ID for a channel

Body

application/json

text*string

localeenum

Example: "en-US"

arbar-AEbg-BGbn-INca-EScs-CZcy-GBcmn-CNda-DKde-CHde-DEde-ATel-GRen-AUen-GBen-INen-NZen-ZAen-USen-GB-WLSes-ESes-MXes-USeu-ESfi-FIfil-PHfr-FRfr-BEfr-CAgl-ESgu-INhe-ILhi-INhu-HUid-IDis-ISit-ITja-JPko-KRlt-LTlv-LVms-MYnl-BEnl-NLnb-NOpa-INpl-PLpt-BRpt-PTro-ROru-RUsk-SKsr-RSsv-SEta-INte-INtr-TRth-THuk-UAvi-VNyue-CN

voicestring

loopinteger

timeoutinteger

Response

202400404422

Call Command Say was accepted for processing

Body

application/json

idId-2 (string (uuid))

callIdId-2 (string (uuid))

callFlowIdId-2 (string (uuid))

statusstring

commandstring

conditionsarray of Conditions for command

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/say', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "text": "text"
    }),
});
const data = await response.json();

Response

202400404422

{
  "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

Request Headers

curl -X POST "https://nest.messagebird.one/workspaces/8bc02f53-87ac-48d2-b4fd-c2cf856a305f/channels/880d8171-cbab-47bb-81b6-b1a0902da136/calls/4fc2edf7-68f5-437a-89eb-3ce0095409d6
/say" \
     -H 'Authorization: Bearer {Token}'

Request Body

{
  "text": "Hi there my name is earl",
  "locale": "en-US",
  "voice": "female"
}

Response

{
  "id": "9ec389c1-a37c-44b8-b09d-2fec18b5c7c6",
  "callId": "0374a740-390d-4395-a007-8ca87ce9f9c9",
  "command": "say",
  "status": "accepted"
}