Call a contact

Authorizations

x-api-token

string

header

required

Body

application/json

contact_id

string

required

interview_id

string

required

metadata

object | null

Response

200 - application/json

data

object

data.ai_name

string

data.call_failure_reason

string

data.contact

object

data.conversation_history

object

data.created

string

data.duration_ms

integer

data.end_time

string

data.error_id

string

data.id

string

data.interview

object

data.interview.advanced_settings

object

data.interview.ai_name

string

data.interview.caller_id_id

object

data.interview.created

string

data.interview.error_id

string

data.interview.folder_id

object

data.interview.genius_id

object

data.interview.id

string

data.interview.lang

string

data.interview.metrics

object

data.interview.note_to_subject

string

data.interview.notifications

string

data.interview.personality_customization

object

data.interview.presence_background_audio

string

data.interview.presence_interim_audio

string

data.interview.response_tags

string

data.interview.should_leave_voicemail

string

data.interview.should_record

string

data.interview.status

enum<string>

Available options:

ACTIVE,

ARCHIVED

data.interview.team_id

object

data.interview.title

string

data.interview.type

enum<string>

Available options:

GENERAL,

POLITICAL_POLLING,

SALES,

CANDIDATE_SCREENING,

MARKET_RESEARCH,

PRODUCT_REVIEW,

VIRTUAL_RECEPTIONIST,

CUSTOMER_SERVICE,

CUSTOM

data.interview.updated

string

data.interview.version

integer

data.interview.voicemail_message

string

data.job

object

data.job.created

string

data.job.id

string

data.job.interview_id

object

data.job.interview_id.advanced_settings

object

data.job.interview_id.ai_name

string

data.job.interview_id.caller_id_id

object

data.job.interview_id.created

string

data.job.interview_id.error_id

string

data.job.interview_id.folder_id

object

data.job.interview_id.genius_id

object

data.job.interview_id.id

string

data.job.interview_id.lang

string

data.job.interview_id.metrics

object

data.job.interview_id.note_to_subject

string

data.job.interview_id.notifications

string

data.job.interview_id.personality_customization

object

data.job.interview_id.presence_background_audio

string

data.job.interview_id.presence_interim_audio

string

data.job.interview_id.response_tags

string

data.job.interview_id.should_leave_voicemail

string

data.job.interview_id.should_record

string

data.job.interview_id.status

enum<string>

Available options:

ACTIVE,

ARCHIVED

data.job.interview_id.team_id

object

data.job.interview_id.title

string

data.job.interview_id.type

enum<string>

Available options:

GENERAL,

POLITICAL_POLLING,

SALES,

CANDIDATE_SCREENING,

MARKET_RESEARCH,

PRODUCT_REVIEW,

VIRTUAL_RECEPTIONIST,

CUSTOMER_SERVICE,

CUSTOM

data.job.interview_id.updated

string

data.job.interview_id.version

integer

data.job.interview_id.voicemail_message

string

data.job.logs

object

data.job.note

string

data.job.rdd_config

object

data.job.status

enum<string>

Available options:

NOT_STARTED,

IN_PROGRESS,

CANCELED,

COMPLETE

data.job.team_id

object

data.job.type

enum<string>

Available options:

CONTACTS,

SMS,

RESPONSES,

GENERAL

data.job.updated

string

data.job.version

integer

data.metadata

object

data.phone_number

string

data.recording_url

string

data.start_time

string

data.status

enum<string>

Available options:

NOT_STARTED,

IN_PROGRESS,

ENDED,

NO_ANSWER,

LEFT_VOICEMAIL,

TRANSFERRED,

FAILED,

VIOLATION

data.summary_data

object

data.team_id

object

data.triggered_metadata

object

data.twilio_sid

string

data.type

enum<string>

Available options:

PHONE_CALL,

BROWSER_CALL,

BROWSER_TEXT,

AGENT_TRANSFER,

SMS,

INBOUND_CALL,

WIDGET

data.updated

string

data.version

integer

error

object | null

job

contact

interview

user

webhooks

Authorizations

Body

Response