API Reference

Make Call

post
https://api.naxai.com/voice/call

Make an outbound call

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length ≤ 64

An identifier for the batch sending

to
array of strings
required
length between 1 and 1000

The destination number to call, numbers are in E.164 format without leading +.

to*
string
required
length between 8 and 15

The phone number to use when performing call in E.164 format without leading +.

string
enum
required

The language to use for the Text-To-Speech.

Allowed:
string
enum
Defaults to woman

The voice to use for the Text-To-Speech: woman or man.

Allowed:
string
length between 1 and 128

An optional idempotency key. Valid chars: a-zA-Z0-9_-

uuid

Used to set specific delivery window outside of which messages won't be delivered. See Calendars to define Time Windows.

integer

If the call must be scheduled, the date provided must be less than 7 days in the future.

boolean
Defaults to false

Enable Answering machine detection.

voicemail
object
welcome
object
required
menu
object
end
object
Headers
string
Defaults to 2023-03-25

The version of API, by default use the last version.

Responses

Updated 9 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago