Create a batch call
post/create-batch-call
Request body
Example request
{
"name": "First batch call",
"trigger_timestamp": 1735718400000,
"from_number": "+14157774444",
"tasks": [
{
"to_number": "+12137774445",
"override_agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
"override_agent_version": 1,
"agent_override": {
"agent": {
"agent_name": "Jarvis",
"version_description": "Customer support agent for handling product inquiries",
"voice_id": "retell-Cimo",
"fallback_voice_ids": [
"cartesia-Cimo",
"minimax-Cimo"
],
"voice_temperature": 1,
"voice_speed": 1,
"enable_dynamic_voice_speed": true,
"enable_dynamic_responsiveness": true,
"volume": 1,
"voice_emotion": "calm",
"responsiveness": 1,
"interruption_sensitivity": 1,
"enable_backchannel": true,
"backchannel_frequency": 0.9,
"backchannel_words": [
"yeah",
"uh-huh"
],
"reminder_trigger_ms": 10000,
"reminder_max_count": 2,
"ambient_sound_volume": 1,
"language": "en-US",
"webhook_url": "https://webhook-url-here",
"webhook_timeout_ms": 10000,
"boosted_keywords": [
"retell",
"kroger"
],
"data_storage_setting": "everything",
"data_storage_retention_days": 30,
"opt_in_signed_url": true,
"signed_url_expiration_ms": 86400000,
"pronunciation_dictionary": [
{
"word": "actually",
"alphabet": "ipa",
"phoneme": "ˈæktʃuəli"
}
],
"end_call_after_silence_ms": 600000,
"max_call_duration_ms": 3600000,
"voicemail_message": "Hi, please give us a callback.",
"voicemail_detection_timeout_ms": 30000,
"voicemail_option": {
"action": {
"type": "static_text",
"text": "Please give us a callback tomorrow at 10am."
}
},
"ivr_option": {
"action": {
"type": "hangup"
}
},
"call_screening_option": {
"agent_identity": "Acme Health scheduling team",
"call_purpose": "confirming your appointment for tomorrow"
},
"post_call_analysis_data": [
{
"type": "string",
"name": "customer_name",
"description": "The name of the customer.",
"examples": [
"John Doe",
"Jane Smith"
]
}
],
"analysis_successful_prompt": "The agent finished the task and the call was complete without being cutoff.",
"analysis_summary_prompt": "Summarize the outcome of the conversation in two sentences.",
"analysis_user_sentiment_prompt": "Evaluate the user's sentiment based on their tone and satisfaction level.",
"begin_message_delay_ms": 1000,
"ring_duration_ms": 30000,
"stt_mode": "fast",
"vocab_specialization": "general",
"allow_user_dtmf": true,
"user_dtmf_options": {
"termination_key": "#"
},
"denoising_mode": "noise-cancellation",
"timezone": "America/New_York"
},
"retell_llm": {
"s2s_model": "gpt-realtime-1.5",
"model_high_priority": true,
"tool_call_strict_mode": true,
"kb_config": {
"top_k": 3,
"filter_score": 0.6
},
"begin_after_user_silence_ms": 2000,
"begin_message": "Hey I am a virtual assistant calling from Retell Hospital."
},
"conversation_flow": {
"model_temperature": 0.7,
"tool_call_strict_mode": true,
"knowledge_base_ids": [
"kb_001",
"kb_002"
],
"kb_config": {
"top_k": 3,
"filter_score": 0.6
},
"start_speaker": "agent",
"begin_after_user_silence_ms": 2000
}
},
"retell_llm_dynamic_variables": {
"customer_name": "John Doe"
},
"custom_sip_headers": {
"X-Custom-Header": "Custom Value"
}
}
],
"call_time_window": {
"windows": [
{
"start": 540,
"end": 1020
}
]
}
}Response
Successfully created a batch call.
Example response
{
"batch_call_id": "batch_call_dbcc4412483ebfc348abb",
"name": "First batch call",
"from_number": "+14157774444",
"scheduled_timestamp": 1735718400,
"call_time_window": {
"windows": [
{
"start": 540,
"end": 1020
}
]
}
}