cURL
curl --request POST \
--url https://api.aicaller.io/v1/phoneCalls \
--header 'Content-Type: application/json' \
--header 'aicaller-api-key: <api-key>' \
--data '
{
"teamId": "363573667364666473667332",
"callTemplateId": "363573667364666473667332",
"nameOfHuman": "John",
"toPhoneNumber": "+1234567890",
"promptVariableValues": [
{
"key": "customer_name",
"value": "John"
}
],
"phoneNumberId": "363573667364666473667332",
"fromPhoneNumber": "+1234567890",
"toEmailAddress": "[email protected]",
"status": "queued",
"telephonyProvider": "twilio",
"record": false,
"callDelayedUntil": "2023-10-12T09:08:00.387Z",
"phoneCallWebhooks": [
{
"url": "https://hooks.abc.com/",
"subscribedEvent": "phoneCall.completed",
"secret": "NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12"
}
]
}
'import requests
url = "https://api.aicaller.io/v1/phoneCalls"
payload = {
"teamId": "363573667364666473667332",
"callTemplateId": "363573667364666473667332",
"nameOfHuman": "John",
"toPhoneNumber": "+1234567890",
"promptVariableValues": [
{
"key": "customer_name",
"value": "John"
}
],
"phoneNumberId": "363573667364666473667332",
"fromPhoneNumber": "+1234567890",
"toEmailAddress": "[email protected]",
"status": "queued",
"telephonyProvider": "twilio",
"record": False,
"callDelayedUntil": "2023-10-12T09:08:00.387Z",
"phoneCallWebhooks": [
{
"url": "https://hooks.abc.com/",
"subscribedEvent": "phoneCall.completed",
"secret": "NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12"
}
]
}
headers = {
"aicaller-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'aicaller-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
teamId: '363573667364666473667332',
callTemplateId: '363573667364666473667332',
nameOfHuman: 'John',
toPhoneNumber: '+1234567890',
promptVariableValues: [{key: 'customer_name', value: 'John'}],
phoneNumberId: '363573667364666473667332',
fromPhoneNumber: '+1234567890',
toEmailAddress: '[email protected]',
status: 'queued',
telephonyProvider: 'twilio',
record: false,
callDelayedUntil: '2023-10-12T09:08:00.387Z',
phoneCallWebhooks: [
{
url: 'https://hooks.abc.com/',
subscribedEvent: 'phoneCall.completed',
secret: 'NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12'
}
]
})
};
fetch('https://api.aicaller.io/v1/phoneCalls', 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.aicaller.io/v1/phoneCalls",
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([
'teamId' => '363573667364666473667332',
'callTemplateId' => '363573667364666473667332',
'nameOfHuman' => 'John',
'toPhoneNumber' => '+1234567890',
'promptVariableValues' => [
[
'key' => 'customer_name',
'value' => 'John'
]
],
'phoneNumberId' => '363573667364666473667332',
'fromPhoneNumber' => '+1234567890',
'toEmailAddress' => '[email protected]',
'status' => 'queued',
'telephonyProvider' => 'twilio',
'record' => false,
'callDelayedUntil' => '2023-10-12T09:08:00.387Z',
'phoneCallWebhooks' => [
[
'url' => 'https://hooks.abc.com/',
'subscribedEvent' => 'phoneCall.completed',
'secret' => 'NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"aicaller-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aicaller.io/v1/phoneCalls"
payload := strings.NewReader("{\n \"teamId\": \"363573667364666473667332\",\n \"callTemplateId\": \"363573667364666473667332\",\n \"nameOfHuman\": \"John\",\n \"toPhoneNumber\": \"+1234567890\",\n \"promptVariableValues\": [\n {\n \"key\": \"customer_name\",\n \"value\": \"John\"\n }\n ],\n \"phoneNumberId\": \"363573667364666473667332\",\n \"fromPhoneNumber\": \"+1234567890\",\n \"toEmailAddress\": \"[email protected]\",\n \"status\": \"queued\",\n \"telephonyProvider\": \"twilio\",\n \"record\": false,\n \"callDelayedUntil\": \"2023-10-12T09:08:00.387Z\",\n \"phoneCallWebhooks\": [\n {\n \"url\": \"https://hooks.abc.com/\",\n \"subscribedEvent\": \"phoneCall.completed\",\n \"secret\": \"NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("aicaller-api-key", "<api-key>")
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.aicaller.io/v1/phoneCalls")
.header("aicaller-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"teamId\": \"363573667364666473667332\",\n \"callTemplateId\": \"363573667364666473667332\",\n \"nameOfHuman\": \"John\",\n \"toPhoneNumber\": \"+1234567890\",\n \"promptVariableValues\": [\n {\n \"key\": \"customer_name\",\n \"value\": \"John\"\n }\n ],\n \"phoneNumberId\": \"363573667364666473667332\",\n \"fromPhoneNumber\": \"+1234567890\",\n \"toEmailAddress\": \"[email protected]\",\n \"status\": \"queued\",\n \"telephonyProvider\": \"twilio\",\n \"record\": false,\n \"callDelayedUntil\": \"2023-10-12T09:08:00.387Z\",\n \"phoneCallWebhooks\": [\n {\n \"url\": \"https://hooks.abc.com/\",\n \"subscribedEvent\": \"phoneCall.completed\",\n \"secret\": \"NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aicaller.io/v1/phoneCalls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["aicaller-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"teamId\": \"363573667364666473667332\",\n \"callTemplateId\": \"363573667364666473667332\",\n \"nameOfHuman\": \"John\",\n \"toPhoneNumber\": \"+1234567890\",\n \"promptVariableValues\": [\n {\n \"key\": \"customer_name\",\n \"value\": \"John\"\n }\n ],\n \"phoneNumberId\": \"363573667364666473667332\",\n \"fromPhoneNumber\": \"+1234567890\",\n \"toEmailAddress\": \"[email protected]\",\n \"status\": \"queued\",\n \"telephonyProvider\": \"twilio\",\n \"record\": false,\n \"callDelayedUntil\": \"2023-10-12T09:08:00.387Z\",\n \"phoneCallWebhooks\": [\n {\n \"url\": \"https://hooks.abc.com/\",\n \"subscribedEvent\": \"phoneCall.completed\",\n \"secret\": \"NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"teamId": "363573667364666473667332",
"callTemplateId": "363573667364666473667332",
"nameOfHuman": "John",
"toPhoneNumber": "+1234567890",
"promptVariableValues": [
{
"key": "customer_name",
"value": "John"
}
],
"_id": "12345678901234567890",
"createdAt": "<string>",
"updatedAt": "<string>",
"phoneNumberId": "363573667364666473667332",
"fromPhoneNumber": "+1234567890",
"toEmailAddress": "[email protected]",
"status": "queued",
"telephonyProvider": "twilio",
"record": false,
"callDelayedUntil": "2023-10-12T09:08:00.387Z",
"phoneCallWebhooks": [
{
"url": "https://hooks.abc.com/",
"subscribedEvent": "phoneCall.completed",
"secret": "NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12"
}
]
}
}{
"error": {
"statusCode": 400,
"message": [
"Invalid input"
],
"error": "Bad Request"
},
"payload": {}
}{
"error": {
"statusCode": 401,
"message": [
"Unauthorized"
],
"error": "Unauthorized"
},
"payload": {}
}{
"error": {
"statusCode": 403,
"message": [
"Forbidden resource"
],
"error": "Forbidden"
},
"payload": {}
}{
"error": {
"statusCode": 404,
"message": [
"Not Found"
],
"error": "Not Found"
},
"payload": {}
}{
"error": {
"error": "Internal Server Error",
"message": [
"INTERNAL_ERROR"
],
"statusCode": 500
},
"payload": {}
}Phone Calls
Post Phonecall
Create a new PhoneCall
POST
/
v1
/
phoneCalls
cURL
curl --request POST \
--url https://api.aicaller.io/v1/phoneCalls \
--header 'Content-Type: application/json' \
--header 'aicaller-api-key: <api-key>' \
--data '
{
"teamId": "363573667364666473667332",
"callTemplateId": "363573667364666473667332",
"nameOfHuman": "John",
"toPhoneNumber": "+1234567890",
"promptVariableValues": [
{
"key": "customer_name",
"value": "John"
}
],
"phoneNumberId": "363573667364666473667332",
"fromPhoneNumber": "+1234567890",
"toEmailAddress": "[email protected]",
"status": "queued",
"telephonyProvider": "twilio",
"record": false,
"callDelayedUntil": "2023-10-12T09:08:00.387Z",
"phoneCallWebhooks": [
{
"url": "https://hooks.abc.com/",
"subscribedEvent": "phoneCall.completed",
"secret": "NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12"
}
]
}
'import requests
url = "https://api.aicaller.io/v1/phoneCalls"
payload = {
"teamId": "363573667364666473667332",
"callTemplateId": "363573667364666473667332",
"nameOfHuman": "John",
"toPhoneNumber": "+1234567890",
"promptVariableValues": [
{
"key": "customer_name",
"value": "John"
}
],
"phoneNumberId": "363573667364666473667332",
"fromPhoneNumber": "+1234567890",
"toEmailAddress": "[email protected]",
"status": "queued",
"telephonyProvider": "twilio",
"record": False,
"callDelayedUntil": "2023-10-12T09:08:00.387Z",
"phoneCallWebhooks": [
{
"url": "https://hooks.abc.com/",
"subscribedEvent": "phoneCall.completed",
"secret": "NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12"
}
]
}
headers = {
"aicaller-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'aicaller-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
teamId: '363573667364666473667332',
callTemplateId: '363573667364666473667332',
nameOfHuman: 'John',
toPhoneNumber: '+1234567890',
promptVariableValues: [{key: 'customer_name', value: 'John'}],
phoneNumberId: '363573667364666473667332',
fromPhoneNumber: '+1234567890',
toEmailAddress: '[email protected]',
status: 'queued',
telephonyProvider: 'twilio',
record: false,
callDelayedUntil: '2023-10-12T09:08:00.387Z',
phoneCallWebhooks: [
{
url: 'https://hooks.abc.com/',
subscribedEvent: 'phoneCall.completed',
secret: 'NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12'
}
]
})
};
fetch('https://api.aicaller.io/v1/phoneCalls', 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.aicaller.io/v1/phoneCalls",
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([
'teamId' => '363573667364666473667332',
'callTemplateId' => '363573667364666473667332',
'nameOfHuman' => 'John',
'toPhoneNumber' => '+1234567890',
'promptVariableValues' => [
[
'key' => 'customer_name',
'value' => 'John'
]
],
'phoneNumberId' => '363573667364666473667332',
'fromPhoneNumber' => '+1234567890',
'toEmailAddress' => '[email protected]',
'status' => 'queued',
'telephonyProvider' => 'twilio',
'record' => false,
'callDelayedUntil' => '2023-10-12T09:08:00.387Z',
'phoneCallWebhooks' => [
[
'url' => 'https://hooks.abc.com/',
'subscribedEvent' => 'phoneCall.completed',
'secret' => 'NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"aicaller-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aicaller.io/v1/phoneCalls"
payload := strings.NewReader("{\n \"teamId\": \"363573667364666473667332\",\n \"callTemplateId\": \"363573667364666473667332\",\n \"nameOfHuman\": \"John\",\n \"toPhoneNumber\": \"+1234567890\",\n \"promptVariableValues\": [\n {\n \"key\": \"customer_name\",\n \"value\": \"John\"\n }\n ],\n \"phoneNumberId\": \"363573667364666473667332\",\n \"fromPhoneNumber\": \"+1234567890\",\n \"toEmailAddress\": \"[email protected]\",\n \"status\": \"queued\",\n \"telephonyProvider\": \"twilio\",\n \"record\": false,\n \"callDelayedUntil\": \"2023-10-12T09:08:00.387Z\",\n \"phoneCallWebhooks\": [\n {\n \"url\": \"https://hooks.abc.com/\",\n \"subscribedEvent\": \"phoneCall.completed\",\n \"secret\": \"NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("aicaller-api-key", "<api-key>")
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.aicaller.io/v1/phoneCalls")
.header("aicaller-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"teamId\": \"363573667364666473667332\",\n \"callTemplateId\": \"363573667364666473667332\",\n \"nameOfHuman\": \"John\",\n \"toPhoneNumber\": \"+1234567890\",\n \"promptVariableValues\": [\n {\n \"key\": \"customer_name\",\n \"value\": \"John\"\n }\n ],\n \"phoneNumberId\": \"363573667364666473667332\",\n \"fromPhoneNumber\": \"+1234567890\",\n \"toEmailAddress\": \"[email protected]\",\n \"status\": \"queued\",\n \"telephonyProvider\": \"twilio\",\n \"record\": false,\n \"callDelayedUntil\": \"2023-10-12T09:08:00.387Z\",\n \"phoneCallWebhooks\": [\n {\n \"url\": \"https://hooks.abc.com/\",\n \"subscribedEvent\": \"phoneCall.completed\",\n \"secret\": \"NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aicaller.io/v1/phoneCalls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["aicaller-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"teamId\": \"363573667364666473667332\",\n \"callTemplateId\": \"363573667364666473667332\",\n \"nameOfHuman\": \"John\",\n \"toPhoneNumber\": \"+1234567890\",\n \"promptVariableValues\": [\n {\n \"key\": \"customer_name\",\n \"value\": \"John\"\n }\n ],\n \"phoneNumberId\": \"363573667364666473667332\",\n \"fromPhoneNumber\": \"+1234567890\",\n \"toEmailAddress\": \"[email protected]\",\n \"status\": \"queued\",\n \"telephonyProvider\": \"twilio\",\n \"record\": false,\n \"callDelayedUntil\": \"2023-10-12T09:08:00.387Z\",\n \"phoneCallWebhooks\": [\n {\n \"url\": \"https://hooks.abc.com/\",\n \"subscribedEvent\": \"phoneCall.completed\",\n \"secret\": \"NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"teamId": "363573667364666473667332",
"callTemplateId": "363573667364666473667332",
"nameOfHuman": "John",
"toPhoneNumber": "+1234567890",
"promptVariableValues": [
{
"key": "customer_name",
"value": "John"
}
],
"_id": "12345678901234567890",
"createdAt": "<string>",
"updatedAt": "<string>",
"phoneNumberId": "363573667364666473667332",
"fromPhoneNumber": "+1234567890",
"toEmailAddress": "[email protected]",
"status": "queued",
"telephonyProvider": "twilio",
"record": false,
"callDelayedUntil": "2023-10-12T09:08:00.387Z",
"phoneCallWebhooks": [
{
"url": "https://hooks.abc.com/",
"subscribedEvent": "phoneCall.completed",
"secret": "NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12"
}
]
}
}{
"error": {
"statusCode": 400,
"message": [
"Invalid input"
],
"error": "Bad Request"
},
"payload": {}
}{
"error": {
"statusCode": 401,
"message": [
"Unauthorized"
],
"error": "Unauthorized"
},
"payload": {}
}{
"error": {
"statusCode": 403,
"message": [
"Forbidden resource"
],
"error": "Forbidden"
},
"payload": {}
}{
"error": {
"statusCode": 404,
"message": [
"Not Found"
],
"error": "Not Found"
},
"payload": {}
}{
"error": {
"error": "Internal Server Error",
"message": [
"INTERNAL_ERROR"
],
"statusCode": 500
},
"payload": {}
}Authorizations
Body
application/json
The unique ID of the Team, phoneCall associated with.
Example:
"363573667364666473667332"
The ID of the call template used for the call.
Example:
"363573667364666473667332"
The name of the human making the call to.
Example:
"John"
The phone number the call is made to.
Example:
"+1234567890"
Array of prompt variables used in the call.
Show child attributes
Show child attributes
The ID of the phone number associated with the call.
Example:
"363573667364666473667332"
The optional phone number the call should be made from. If not provided AI will use a number from twilio settings.
Example:
"+1234567890"
The email of the person, the call is made to.
Example:
The status of the phone call. Possible values: "queued", "ringing", "inProgress", "busy", "noAnswer", "canceled", "failed", "completed".
Available options:
queued, ringing, inProgress, busy, failed, noAnswer, cancelled, completed Example:
"queued"
The telephony provider to be used for the phone call. Possible values: "twilio", "plivo", "telnyx".
Available options:
twilio, plivo, telnyx Example:
"twilio"
Flag indicating whether recording is enabled for the specific phone call.
Example:
false
Can be used to schedule a call for the future. Must be ISO Date as a string with UTC timezone.
Example:
"2023-10-12T09:08:00.387Z"
Array of webhooks to be notified for this call.
Show child attributes
Show child attributes
Response
Phone call successfully created.
Show child attributes
Show child attributes