No-code docs
Resources

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

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
voicestring
loopinteger
timeoutinteger
localestring · enum · default: en-US
Example: en-US
Options: arb, ar-AE, bg-BG, bn-IN, ca-ES, cs-CZ, cy-GB, cmn-CN, da-DK, de-CH, de-DE, de-AT, el-GR, en-AU, en-GB, en-IN, en-NZ, en-ZA, en-US, en-GB-WLS, es-ES, es-MX, es-US, eu-ES, fi-FI, fil-PH, fr-FR, fr-BE, fr-CA, gl-ES, gu-IN, he-IL, hi-IN, hu-HU, id-ID, is-IS, it-IT, ja-JP, ko-KR, lt-LT, lv-LV, ms-MY, nl-BE, nl-NL, nb-NO, pa-IN, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sk-SK, sr-RS, sv-SE, ta-IN, te-IN, tr-TR, th-TH, uk-UA, vi-VN, yue-CN
Responses
curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/say' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"text":"text","locale":"en-US"}'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "callId": "123e4567-e89b-12d3-a456-426614174000",
  "callFlowId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "text",
  "command": "text",
  "conditions": [
    {
      "value": "text",
      "variable": "keys",
      "operator": "eq"
    }
  ]
}

Call Command Say was accepted for processing

Example 1: Play an announcement when an outbound call is running

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}'

Last updated

Was this helpful?