Create a phone call
curl --request POST \
--url https://api.cal.com/v2/teams/{teamId}/event-types/{eventTypeId}/create-phone-call \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"yourPhoneNumber": "<string>",
"numberToCall": "<string>",
"calApiKey": "<string>",
"enabled": true,
"templateType": "CUSTOM_TEMPLATE",
"schedulerName": "<string>",
"guestName": "<string>",
"guestEmail": "<string>",
"guestCompany": "<string>",
"beginMessage": "<string>",
"generalPrompt": "<string>"
}
'import requests
url = "https://api.cal.com/v2/teams/{teamId}/event-types/{eventTypeId}/create-phone-call"
payload = {
"yourPhoneNumber": "<string>",
"numberToCall": "<string>",
"calApiKey": "<string>",
"enabled": True,
"templateType": "CUSTOM_TEMPLATE",
"schedulerName": "<string>",
"guestName": "<string>",
"guestEmail": "<string>",
"guestCompany": "<string>",
"beginMessage": "<string>",
"generalPrompt": "<string>"
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
yourPhoneNumber: '<string>',
numberToCall: '<string>',
calApiKey: '<string>',
enabled: true,
templateType: 'CUSTOM_TEMPLATE',
schedulerName: '<string>',
guestName: '<string>',
guestEmail: '<string>',
guestCompany: '<string>',
beginMessage: '<string>',
generalPrompt: '<string>'
})
};
fetch('https://api.cal.com/v2/teams/{teamId}/event-types/{eventTypeId}/create-phone-call', 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.cal.com/v2/teams/{teamId}/event-types/{eventTypeId}/create-phone-call",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'yourPhoneNumber' => '<string>',
'numberToCall' => '<string>',
'calApiKey' => '<string>',
'enabled' => true,
'templateType' => 'CUSTOM_TEMPLATE',
'schedulerName' => '<string>',
'guestName' => '<string>',
'guestEmail' => '<string>',
'guestCompany' => '<string>',
'beginMessage' => '<string>',
'generalPrompt' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cal.com/v2/teams/{teamId}/event-types/{eventTypeId}/create-phone-call"
payload := strings.NewReader("{\n \"yourPhoneNumber\": \"<string>\",\n \"numberToCall\": \"<string>\",\n \"calApiKey\": \"<string>\",\n \"enabled\": true,\n \"templateType\": \"CUSTOM_TEMPLATE\",\n \"schedulerName\": \"<string>\",\n \"guestName\": \"<string>\",\n \"guestEmail\": \"<string>\",\n \"guestCompany\": \"<string>\",\n \"beginMessage\": \"<string>\",\n \"generalPrompt\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cal.com/v2/teams/{teamId}/event-types/{eventTypeId}/create-phone-call")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"yourPhoneNumber\": \"<string>\",\n \"numberToCall\": \"<string>\",\n \"calApiKey\": \"<string>\",\n \"enabled\": true,\n \"templateType\": \"CUSTOM_TEMPLATE\",\n \"schedulerName\": \"<string>\",\n \"guestName\": \"<string>\",\n \"guestEmail\": \"<string>\",\n \"guestCompany\": \"<string>\",\n \"beginMessage\": \"<string>\",\n \"generalPrompt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cal.com/v2/teams/{teamId}/event-types/{eventTypeId}/create-phone-call")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"yourPhoneNumber\": \"<string>\",\n \"numberToCall\": \"<string>\",\n \"calApiKey\": \"<string>\",\n \"enabled\": true,\n \"templateType\": \"CUSTOM_TEMPLATE\",\n \"schedulerName\": \"<string>\",\n \"guestName\": \"<string>\",\n \"guestEmail\": \"<string>\",\n \"guestCompany\": \"<string>\",\n \"beginMessage\": \"<string>\",\n \"generalPrompt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"callId": "<string>",
"agentId": "<string>"
}
}Event Types
Create a phone call
If accessed using an OAuth access token, the TEAM_EVENT_TYPE_WRITE scope is required.
POST
/
v2
/
teams
/
{teamId}
/
event-types
/
{eventTypeId}
/
create-phone-call
Create a phone call
curl --request POST \
--url https://api.cal.com/v2/teams/{teamId}/event-types/{eventTypeId}/create-phone-call \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"yourPhoneNumber": "<string>",
"numberToCall": "<string>",
"calApiKey": "<string>",
"enabled": true,
"templateType": "CUSTOM_TEMPLATE",
"schedulerName": "<string>",
"guestName": "<string>",
"guestEmail": "<string>",
"guestCompany": "<string>",
"beginMessage": "<string>",
"generalPrompt": "<string>"
}
'import requests
url = "https://api.cal.com/v2/teams/{teamId}/event-types/{eventTypeId}/create-phone-call"
payload = {
"yourPhoneNumber": "<string>",
"numberToCall": "<string>",
"calApiKey": "<string>",
"enabled": True,
"templateType": "CUSTOM_TEMPLATE",
"schedulerName": "<string>",
"guestName": "<string>",
"guestEmail": "<string>",
"guestCompany": "<string>",
"beginMessage": "<string>",
"generalPrompt": "<string>"
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
yourPhoneNumber: '<string>',
numberToCall: '<string>',
calApiKey: '<string>',
enabled: true,
templateType: 'CUSTOM_TEMPLATE',
schedulerName: '<string>',
guestName: '<string>',
guestEmail: '<string>',
guestCompany: '<string>',
beginMessage: '<string>',
generalPrompt: '<string>'
})
};
fetch('https://api.cal.com/v2/teams/{teamId}/event-types/{eventTypeId}/create-phone-call', 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.cal.com/v2/teams/{teamId}/event-types/{eventTypeId}/create-phone-call",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'yourPhoneNumber' => '<string>',
'numberToCall' => '<string>',
'calApiKey' => '<string>',
'enabled' => true,
'templateType' => 'CUSTOM_TEMPLATE',
'schedulerName' => '<string>',
'guestName' => '<string>',
'guestEmail' => '<string>',
'guestCompany' => '<string>',
'beginMessage' => '<string>',
'generalPrompt' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cal.com/v2/teams/{teamId}/event-types/{eventTypeId}/create-phone-call"
payload := strings.NewReader("{\n \"yourPhoneNumber\": \"<string>\",\n \"numberToCall\": \"<string>\",\n \"calApiKey\": \"<string>\",\n \"enabled\": true,\n \"templateType\": \"CUSTOM_TEMPLATE\",\n \"schedulerName\": \"<string>\",\n \"guestName\": \"<string>\",\n \"guestEmail\": \"<string>\",\n \"guestCompany\": \"<string>\",\n \"beginMessage\": \"<string>\",\n \"generalPrompt\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cal.com/v2/teams/{teamId}/event-types/{eventTypeId}/create-phone-call")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"yourPhoneNumber\": \"<string>\",\n \"numberToCall\": \"<string>\",\n \"calApiKey\": \"<string>\",\n \"enabled\": true,\n \"templateType\": \"CUSTOM_TEMPLATE\",\n \"schedulerName\": \"<string>\",\n \"guestName\": \"<string>\",\n \"guestEmail\": \"<string>\",\n \"guestCompany\": \"<string>\",\n \"beginMessage\": \"<string>\",\n \"generalPrompt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cal.com/v2/teams/{teamId}/event-types/{eventTypeId}/create-phone-call")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"yourPhoneNumber\": \"<string>\",\n \"numberToCall\": \"<string>\",\n \"calApiKey\": \"<string>\",\n \"enabled\": true,\n \"templateType\": \"CUSTOM_TEMPLATE\",\n \"schedulerName\": \"<string>\",\n \"guestName\": \"<string>\",\n \"guestEmail\": \"<string>\",\n \"guestCompany\": \"<string>\",\n \"beginMessage\": \"<string>\",\n \"generalPrompt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"callId": "<string>",
"agentId": "<string>"
}
}Headers
value must be Bearer <token> where <token> is api key prefixed with cal_
Body
application/json
Your phone number
Pattern:
/^\+[1-9]\d{1,14}$/Number to call
Pattern:
/^\+[1-9]\d{1,14}$/CAL API Key
Enabled status
Template type
Available options:
CHECK_IN_APPOINTMENT, CUSTOM_TEMPLATE Scheduler name
Guest name
Guest email
Guest company
Begin message
General prompt
Was this page helpful?
⌘I