Voice OTP

Server

One-time password delivery via voice call

Send Voice OTP

POST

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

/chatterwave/voice-otp/

Initiates an outbound call to deliver a one-time password. The OTP is spoken digit-by-digit with configurable repetition.

The call originates from the specified DID, which must be provisioned and owned by the authenticated account.

Send Voice OTP › Request Body

VoiceOtpRequest

from

string · required

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

Example: +14155550100

to

string · required

Destination phone number in E.164 format

Example: +14155551234

otp

string · pattern: ^[0-9]{1,10}$ · required

One-time password to deliver (digits only, max 10 characters)

Example: 123456

session_id

string · uuid

Optional session identifier. If not provided, one will be generated.

repeat

integer · min: 1 · max: 3

Number of times to repeat the OTP

Default: 2

language

string

BCP-47 language code for speech synthesis

Example: en-US

Default: en-US

speaking_rate

number · float · min: 0.25 · max: 2

Speech rate multiplier

Default: 1

custom_message

string · maxLength: 40

Custom message template (max 40 characters). Use {otp} as placeholder.

Example: Your code is {otp}

callback_url

string · uri

Webhook URL for call status notifications

Send Voice OTP › Responses

Call initiated

VoiceOtpResponse

session_id

string · uuid

Unique identifier for the call session

status

string

Current call status

Example: queued

POST/chatterwave/voice-otp/

curl https://api.helios.pressone.co/api/v1/chatterwave/voice-otp \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic <credentials>' \
  --data '{
  "session_id": "00000000-0000-0000-0000-000000000000",
  "from": "+14155550100",
  "to": "+14155551234",
  "otp": "123456",
  "repeat": 2,
  "language": "en-US",
  "speaking_rate": 1,
  "custom_message": "Your code is {otp}",
  "callback_url": "https://www.example.com/path/to/resource"
}'

Example Request Body

{
  "session_id": "00000000-0000-0000-0000-000000000000",
  "from": "+14155550100",
  "to": "+14155551234",
  "otp": "123456",
  "repeat": 2,
  "language": "en-US",
  "speaking_rate": 1,
  "custom_message": "Your code is {otp}",
  "callback_url": "https://www.example.com/path/to/resource"
}

json

Example Responses

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

json

application/json

Text-to-Speech

Send Voice OTP

POST

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

/chatterwave/voice-otp/

Initiates an outbound call to deliver a one-time password. The OTP is spoken digit-by-digit with configurable repetition.

The call originates from the specified DID, which must be provisioned and owned by the authenticated account.

Send Voice OTP › Request Body

VoiceOtpRequest

from

string · required

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

Example: +14155550100

to

string · required

Destination phone number in E.164 format

Example: +14155551234

otp

string · pattern: ^[0-9]{1,10}$ · required

One-time password to deliver (digits only, max 10 characters)

Example: 123456

session_id

string · uuid

Optional session identifier. If not provided, one will be generated.

repeat

integer · min: 1 · max: 3

Number of times to repeat the OTP

Default: 2

language

string

BCP-47 language code for speech synthesis

Example: en-US

Default: en-US

speaking_rate

number · float · min: 0.25 · max: 2

Speech rate multiplier

Default: 1

custom_message

string · maxLength: 40

Custom message template (max 40 characters). Use {otp} as placeholder.

Example: Your code is {otp}

callback_url

string · uri

Webhook URL for call status notifications

Send Voice OTP › Responses

Call initiated

VoiceOtpResponse

session_id

string · uuid

Unique identifier for the call session

status

string

Current call status

Example: queued