cURL
curl --request GET \
--url https://api.qcall.ai/api/v1/user/listAssistant \
--header 'x-api-key: <api-key>'import requests
url = "https://api.qcall.ai/api/v1/user/listAssistant"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.qcall.ai/api/v1/user/listAssistant', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.qcall.ai/api/v1/user/listAssistant",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.qcall.ai/api/v1/user/listAssistant"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.qcall.ai/api/v1/user/listAssistant")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qcall.ai/api/v1/user/listAssistant")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"type": "inbound",
"language": "en",
"name": "<string>",
"company_name": "<string>",
"accent": "<string>",
"goal": "<string>",
"start_speech": "<string>",
"voice_id": "<string>",
"voice_name": "<string>",
"script": "<string>",
"maximum_time_per_call": 123,
"is_voice_note": true,
"voice_note": "<string>",
"ai_model_id": "1",
"sentiment": {
"general_prompt": "<string>",
"positive_prompt": "<string>",
"negative_prompt": "<string>",
"neutral_prompt": "<string>"
},
"voice_speed": 1,
"is_filler": true,
"fillers": "umm",
"assistant_image": "https://precallai.s3.ap-south-1.amazonaws.com/assistant_profile/1.jpeg",
"ai_modal": "<string>",
"sensitivity": 600,
"temperature": 0.7,
"opt_out_script": "If a user explicitly expresses that they no longer wish to receive calls, such as by saying 'Don't call me again,' 'I'm not interested,' or any similar phrase indicating that they want to opt out of future communications, please trigger the 'optOut' function and inform the user that they will no longer be contacted for calls.",
"is_wait_start_speech": true,
"utterance_length": 1,
"meeting_note_prompt": "<string>",
"call_outcome_prompt": "<string>",
"actions": [
{
"type": "scheduleMeeting",
"meetingType": "openBooking",
"timezone": "<string>",
"startDate": "<string>",
"description": "<string>",
"say": "<string>",
"length": 123,
"prompt": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"bookingDays": "<string>",
"sms": {
"is_sms": true,
"description": "<string>",
"content": "<string>",
"end_call_sms": true,
"end_call_sms_not_answered": true
},
"whatsapp": {
"is_whatsapp": true,
"description": "<string>",
"content": {},
"end_call_sms": true,
"end_call_sms_not_answered": true
},
"zeplo": {
"is_zeplo": true,
"description": "<string>",
"content": {
"templateName": "<string>",
"language": "en_US",
"category": "MARKETING",
"parameter_hints": [
"<string>"
],
"parameter_slots": [
{
"section": "header",
"index": 123,
"sub_index": 123,
"label": "<string>"
}
],
"components": [
"<unknown>"
]
},
"end_call_sms": true,
"end_call_sms_not_answered": true
}
}
],
"zapier_hook": "<string>",
"knowledge_base_Id": "<string>",
"is_recording": true,
"is_back_sound": true,
"is_sensitivity": true,
"is_opt_out": true,
"generate_call_flow": true,
"gender": "male",
"is_start_speech_update": true,
"company_website": "<string>",
"eleven_lab_modal": "<string>",
"voice_data": {
"voice_id": "<string>",
"name": "<string>",
"category": "<string>",
"labels": {
"language": "<string>",
"language_name": "<string>",
"gender": "<string>",
"accent": "<string>"
},
"preview_url": "<string>",
"reference_text": "<string>",
"is_native": true,
"categories": [
"<string>"
],
"source": "<string>",
"id": "<string>",
"displayname": "<string>",
"ai_modal": "<string>",
"language": "<string>",
"language_name": "<string>",
"similarity": 123,
"stability": 123
},
"stability": 123,
"similarity": 123,
"style_exaggeration": 123,
"speaker_boost": true,
"safety_fallback_delay": 123,
"enable_delay": true,
"is_call_flow": true,
"call_flow": {},
"background_type": "<string>",
"background_volume": 123,
"end_call_message": "<string>",
"wait_max_interval": 123,
"set_transcription_start_time": 123,
"widget_config": {
"mode": "floating",
"api_key": "<string>",
"enabled": true,
"uiStyle": "<string>",
"position": "<string>",
"containerId": "<string>"
}
}
]{
"error": 123,
"message": "<string>"
}Assistants
Get Assistants
Returns all assistants from the system that the user has access to
GET
/
user
/
listAssistant
cURL
curl --request GET \
--url https://api.qcall.ai/api/v1/user/listAssistant \
--header 'x-api-key: <api-key>'import requests
url = "https://api.qcall.ai/api/v1/user/listAssistant"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.qcall.ai/api/v1/user/listAssistant', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.qcall.ai/api/v1/user/listAssistant",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.qcall.ai/api/v1/user/listAssistant"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.qcall.ai/api/v1/user/listAssistant")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qcall.ai/api/v1/user/listAssistant")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"type": "inbound",
"language": "en",
"name": "<string>",
"company_name": "<string>",
"accent": "<string>",
"goal": "<string>",
"start_speech": "<string>",
"voice_id": "<string>",
"voice_name": "<string>",
"script": "<string>",
"maximum_time_per_call": 123,
"is_voice_note": true,
"voice_note": "<string>",
"ai_model_id": "1",
"sentiment": {
"general_prompt": "<string>",
"positive_prompt": "<string>",
"negative_prompt": "<string>",
"neutral_prompt": "<string>"
},
"voice_speed": 1,
"is_filler": true,
"fillers": "umm",
"assistant_image": "https://precallai.s3.ap-south-1.amazonaws.com/assistant_profile/1.jpeg",
"ai_modal": "<string>",
"sensitivity": 600,
"temperature": 0.7,
"opt_out_script": "If a user explicitly expresses that they no longer wish to receive calls, such as by saying 'Don't call me again,' 'I'm not interested,' or any similar phrase indicating that they want to opt out of future communications, please trigger the 'optOut' function and inform the user that they will no longer be contacted for calls.",
"is_wait_start_speech": true,
"utterance_length": 1,
"meeting_note_prompt": "<string>",
"call_outcome_prompt": "<string>",
"actions": [
{
"type": "scheduleMeeting",
"meetingType": "openBooking",
"timezone": "<string>",
"startDate": "<string>",
"description": "<string>",
"say": "<string>",
"length": 123,
"prompt": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"bookingDays": "<string>",
"sms": {
"is_sms": true,
"description": "<string>",
"content": "<string>",
"end_call_sms": true,
"end_call_sms_not_answered": true
},
"whatsapp": {
"is_whatsapp": true,
"description": "<string>",
"content": {},
"end_call_sms": true,
"end_call_sms_not_answered": true
},
"zeplo": {
"is_zeplo": true,
"description": "<string>",
"content": {
"templateName": "<string>",
"language": "en_US",
"category": "MARKETING",
"parameter_hints": [
"<string>"
],
"parameter_slots": [
{
"section": "header",
"index": 123,
"sub_index": 123,
"label": "<string>"
}
],
"components": [
"<unknown>"
]
},
"end_call_sms": true,
"end_call_sms_not_answered": true
}
}
],
"zapier_hook": "<string>",
"knowledge_base_Id": "<string>",
"is_recording": true,
"is_back_sound": true,
"is_sensitivity": true,
"is_opt_out": true,
"generate_call_flow": true,
"gender": "male",
"is_start_speech_update": true,
"company_website": "<string>",
"eleven_lab_modal": "<string>",
"voice_data": {
"voice_id": "<string>",
"name": "<string>",
"category": "<string>",
"labels": {
"language": "<string>",
"language_name": "<string>",
"gender": "<string>",
"accent": "<string>"
},
"preview_url": "<string>",
"reference_text": "<string>",
"is_native": true,
"categories": [
"<string>"
],
"source": "<string>",
"id": "<string>",
"displayname": "<string>",
"ai_modal": "<string>",
"language": "<string>",
"language_name": "<string>",
"similarity": 123,
"stability": 123
},
"stability": 123,
"similarity": 123,
"style_exaggeration": 123,
"speaker_boost": true,
"safety_fallback_delay": 123,
"enable_delay": true,
"is_call_flow": true,
"call_flow": {},
"background_type": "<string>",
"background_volume": 123,
"end_call_message": "<string>",
"wait_max_interval": 123,
"set_transcription_start_time": 123,
"widget_config": {
"mode": "floating",
"api_key": "<string>",
"enabled": true,
"uiStyle": "<string>",
"position": "<string>",
"containerId": "<string>"
}
}
]{
"error": 123,
"message": "<string>"
}Response
Assistant response
Language of the assistant. Supported values: en (English), de (German), hi (Hindi), es (Spanish), fr (French), it (Italian), ar-kw (Arabic Kuwait), gu (Gujarati), bn (Bengali), te (Telugu India), kn (Kannada India), ta (Tamil India), mr (Marathi).
Available options:
en, de, hi, es, fr, it, ar-kw, gu, bn, te, kn, ta, mr Assistant image url
Available options:
https://precallai.s3.ap-south-1.amazonaws.com/assistant_profile/1.jpeg, https://precallai.s3.ap-south-1.amazonaws.com/assistant_profile/1.jpeg, https://precallai.s3.ap-south-1.amazonaws.com/assistant_profile/3.jpeg, https://precallai.s3.ap-south-1.amazonaws.com/assistant_profile/4.jpeg, https://precallai.s3.ap-south-1.amazonaws.com/assistant_profile/5.jpeg If is_opt_out is enable then add opt out prompts
Available options:
If a user explicitly expresses that they no longer wish to receive calls, such as by saying 'Don't call me again,' 'I'm not interested,' or any similar phrase indicating that they want to opt out of future communications, please trigger the 'optOut' function and inform the user that they will no longer be contacted for calls. 
