Skip to main content
POST
/
call
cURL
curl --request POST \
  --url https://api.meetzy.io/call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phone": "<string>",
  "playbook_id": "<string>",
  "voice_id": "<string>",
  "voice_model": "<string>",
  "language": "<string>",
  "interrupt": true,
  "<custom_param_1>": "<string>",
  "<custom_param_2>": "<string>",
  "<custom_param_N>": "<string>"
}'
{
  "id": "<string>",
  "success": true,
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Params to execute the call

​
phone
string
required

The phone to call with country prefix (e.g. +34600000000).

​
playbook_id
string
required

The id of the playbook you want to use to make the call. You can get the list of playbooks using your dashboard (/playbook endpoint will be available soon).

​
voice_id
string

The number of the voice to use (values: 1, 2, 3, 4, 5, 6, 7) - Default 6.

​
voice_model
string

Choose from our speech models: - 'fast' (less latency, nice voices) or 'human' (our natural sounding voices - (beta)) - Default model: 'human'

​
language
string

The language used by Flark during the call (values: ES, EN, FR, DE, IT, PT, ...) - Default ES.

​
interrupt
boolean

If the user can interrupt to the IA during the call - Default false.

​
<custom_param_1>
string

A custom param like email, firstname, lastname, email, program_of_insterest, etc. Flark will use this param to personalize the call.

​
<custom_param_2>
string

A custom param like email, firstname, lastname, email, program_of_insterest, etc. Flark will use this param to personalize the call.

​
<custom_param_N>
string

You can add as many custom params as you want. Flark will use this param to personalize the call.

Response

Call response

​
id
string

The id of a the call

​
success
boolean

If the call started successfully or not

​
message
string

The message explaining the result of the call initiation