Create Call - Vocode

POST

/

v1

/

calls

/

create

Authorizations

Authorization

string

headerrequired

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

Body

application/json

from_number

string

required

to_number

string

required

agent

required

on_no_human_answer

enum<string>

default: continue

Available options:

continue,

hangup

run_do_not_call_detection

boolean | null

hipaa_compliant

boolean

default: false

context

object | null

telephony_params

object | null

Response

200 - application/json

id

string

required

user_id

string

required

to_number

string

required

from_number

string

required

agent

object

required

agent.id

string

required

agent.user_id

string

required

agent.prompt

object

required

agent.actions

object[]

required

agent.voice

object

required

agent.name

string | null

agent.language

enum<string>

default: en

Available options:

en,

es,

de,

hi,

pt,

fr,

nl,

id,

it,

ja,

ko

agent.initial_message

string | null

agent.webhook

object | null

agent.vector_database

object | null

agent.interrupt_sensitivity

enum<string>

default: low

Available options:

low,

high

agent.context_endpoint

string | null

agent.noise_suppression

boolean

default: false

agent.endpointing_sensitivity

enum<string>

default: auto

Available options:

auto,

relaxed,

sensitive

Available options:

default,

off

agent.conversation_speed

number

default: 1

agent.initial_message_delay

number

default: 0

agent.openai_model_name_override

string | null

agent.ask_if_human_present_on_idle

boolean

default: false

agent.openai_account_connection

object | null

agent.run_do_not_call_detection

boolean

default: false

agent.llm_fallback

object | null

agent.deepgram_keywords

object | null

agent.idle_time_seconds

integer | null

agent.llm_temperature

number

default: 0

telephony_provider

enum<string>

required

Available options:

vonage,

twilio

agent_phone_number

string

required

status

enum<string>

default: not_started

Available options:

not_started,

in_progress,

error,

ended

error_message

string | null

recording_available

boolean

default: false

transcript

string | null

human_detection_result

enum<string> | null

Available options:

human,

no_human

do_not_call_result

boolean | null

telephony_id

string | null

stage

enum<string> | null

Available options:

created,

picked_up,

transfer_started,

transfer_successful

stage_outcome

enum<string> | null

Available options:

human_unanswered,

call_did_not_connect,

human_disconnected,

bot_disconnected,

transfer_unanswered,

transfer_disconnected

telephony_metadata

object | null

start_time

string | null

end_time

string | null

hipaa_compliant

boolean

default: false

on_no_human_answer

enum<string> | null

Available options:

continue,

hangup

context

object | null

run_do_not_call_detection

boolean | null

telephony_account_connection

object | null

telephony_params

object | null

End Call Get Recording