Overview
CallHQ makes it easy to build voice agents that can make and receive phone calls. In under 5 minutes, you’ll create a voice assistant and start interacting over the phone.
In this quickstart, you’ll learn to:
- Create an assistant using the CallHQ Dashboard or programmatically
- Set up a phone number
- Make your first inbound and outbound calls
Prerequisites
Create your first voice assistant
Open the CallHQ Dashboard
Create a new assistant
In the dashboard, navigate to the Assistants section and click “Create Assistant”.
Configure your assistant
Set the first message and system prompt for your assistant.
First message:
Thank you for calling Health Care Solutions. This is Emily, your scheduling assistant. How may I help you today?
System prompt:
# Appointment Scheduling Agent Prompt
## Identity & Purpose
You are Emily, an appointment scheduling voice assistant for Health Care Solutions,
a multi-specialty health clinic. Your primary purpose is to efficiently schedule, confirm,
reschedule, or cancel appointments while providing clear information about services and ensuring a smooth booking experience.
## Voice & Persona
### Personality
- Sound friendly, organized, and efficient
- Project a helpful and patient demeanor, especially with elderly or confused callers
- Maintain a warm but professional tone throughout the conversation
- Convey confidence and competence in managing the scheduling system
Open the CallHQ Dashboard
Create a new assistant
In the dashboard, navigate to the Assistants section and click “Create Assistant”.
Configure your assistant
Set the first message and system prompt for your assistant.
First message:
Thank you for calling Health Care Solutions. This is Emily, your scheduling assistant. How may I help you today?
System prompt:
# Appointment Scheduling Agent Prompt
## Identity & Purpose
You are Emily, an appointment scheduling voice assistant for Health Care Solutions,
a multi-specialty health clinic. Your primary purpose is to efficiently schedule, confirm,
reschedule, or cancel appointments while providing clear information about services and ensuring a smooth booking experience.
## Voice & Persona
### Personality
- Sound friendly, organized, and efficient
- Project a helpful and patient demeanor, especially with elderly or confused callers
- Maintain a warm but professional tone throughout the conversation
- Convey confidence and competence in managing the scheduling system
Create the assistant via API
curl -X 'POST' \
'https://backend-callhq-385086326930.asia-south1.run.app/api/assistants' \
-H 'accept: */*' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"name": "Priya",
"voice": {
"provider": "CallHQ",
"voiceId": "Priya",
"speed": 1
},
"transcriber": {
"provider": "google",
"model": "gemini-1.5-pro",
"language": "Multilingual"
},
"model": {
"provider": "google",
"model": "gemini-1.5-pro",
"temperature": 0.5,
"maxTokens": 250,
"emotionRecognitionEnabled": false,
"messages": [
{
"role": "system",
"content": "This is a blank template with minimal defaults, you can change the model, temperature, and messages."
}
]
},
"firstMessage": "Hello.",
"firstMessageMode": "assistant-speaks-first",
"backgroundSound": "office",
"silenceTimeoutSeconds": 10,
"backgroundDenoisingEnabled": true,
"firstMessageInterruptionsEnabled": false,
"maxDurationSeconds": 3600
}'
Set up a phone number
Purchase or link a phone number
In the Phone Numbers section, either purchase a CallHQ number or link your own via supported providers.
Assign an assistant to the number
Select your assistant in the inbound call configuration. When someone calls this number, your assistant will automatically respond.
Purchase or link a phone number
In the Phone Numbers section, either purchase a CallHQ number or link your own via supported providers.
Assign an assistant to the number
Select your assistant in the inbound call configuration. When someone calls this number, your assistant will automatically respond.
Make your first calls
Test inbound calling
Call the number you’ve configured. Your assistant will pick up and begin the conversation using the defined first message.
Initiate an outbound call via API
curl -X 'POST' \
'https://backend-callhq-385086326930.asia-south1.run.app/api/calls/outbound' \
-H 'accept: */*' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"assistantId": "fe5be098-d76b-7653-b354-bb8246d1d53d",
"phoneNumberId": "59090934-7b8b-45d6-9565-88a9cf53b6fb",
"customer": {
"number": "+919876543210"
}
}'
Next steps
Now that you’ve launched your first voice assistant:
- Customize system prompts for your use case
- Enable API tools to trigger logic and workflows
- Use the dashboard to monitor performance and transcripts
- Scale voice automation with secure, programmable APIs
Ready to add voice into your web app? See the Web integration guide to embed your assistant on any website.
