Text-to-Speech

Server

Voice message broadcasting

Send TTS Message

POST

https://api.helios.pressone.co/api/v1

/chatterwave/tts/

Initiates outbound calls to deliver a voice message. Supports up to 25 recipients per request.

Provide either message for text-to-speech synthesis or resource_id to use a pre-uploaded audio file. These fields are mutually exclusive.

Send TTS Message › Request Body

TtsRequest

from

string · required

Caller ID phone number in E.164 format. Must be a DID owned by the authenticated account.

Example: +14155550100

to

string[] · minItems: 1 · maxItems: 25 · required

Destination phone numbers in E.164 format (1-25 numbers)

session_id

string · uuid

Optional session identifier. If not provided, one will be generated. For multiple recipients, all calls share this session ID.

message

string

Text to synthesize. Mutually exclusive with resource_id.

resource_id

string · uuid

Pre-uploaded audio resource. Mutually exclusive with message.

language

string

BCP-47 language code for speech synthesis

Default: en-US

speaking_rate

number · float · min: 0.25 · max: 2

Speech rate multiplier

Default: 1

callback_url

string · uri

Webhook URL for call status notifications

Send TTS Message › Responses

Calls initiated

TtsResponse

session_id

string · uuid

Unique identifier for the session. For multiple recipients, this serves as the batch ID.

status

string

Current status

Example: queued

POST/chatterwave/tts/

curl https://api.helios.pressone.co/api/v1/chatterwave/tts \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic <credentials>' \
  --data '{
  "session_id": "00000000-0000-0000-0000-000000000000",
  "from": "+14155550100",
  "to": [
    "+14155551234"
  ],
  "message": "message",
  "resource_id": "00000000-0000-0000-0000-000000000000",
  "language": "en-US",
  "speaking_rate": 1,
  "callback_url": "https://www.example.com/path/to/resource"
}'

Example Request Body

{
  "session_id": "00000000-0000-0000-0000-000000000000",
  "from": "+14155550100",
  "to": [
    "+14155551234"
  ],
  "message": "message",
  "resource_id": "00000000-0000-0000-0000-000000000000",
  "language": "en-US",
  "speaking_rate": 1,
  "callback_url": "https://www.example.com/path/to/resource"
}

json

Example Responses

{
  "session_id": "00000000-0000-0000-0000-000000000000",
  "status": "queued"
}

json

application/json

Voice OTP Sessions

Send TTS Message

POST

https://api.helios.pressone.co/api/v1

/chatterwave/tts/

Initiates outbound calls to deliver a voice message. Supports up to 25 recipients per request.

Provide either message for text-to-speech synthesis or resource_id to use a pre-uploaded audio file. These fields are mutually exclusive.

Send TTS Message › Request Body

TtsRequest

from

string · required

Caller ID phone number in E.164 format. Must be a DID owned by the authenticated account.

Example: +14155550100

to

string[] · minItems: 1 · maxItems: 25 · required

Destination phone numbers in E.164 format (1-25 numbers)

session_id

string · uuid

Optional session identifier. If not provided, one will be generated. For multiple recipients, all calls share this session ID.

message

string

Text to synthesize. Mutually exclusive with resource_id.

resource_id

string · uuid

Pre-uploaded audio resource. Mutually exclusive with message.

language

string

BCP-47 language code for speech synthesis

Default: en-US

speaking_rate

number · float · min: 0.25 · max: 2

Speech rate multiplier

Default: 1

callback_url

string · uri

Webhook URL for call status notifications

Send TTS Message › Responses

Calls initiated

TtsResponse

session_id

string · uuid

Unique identifier for the session. For multiple recipients, this serves as the batch ID.

status

string

Current status

Example: queued