curl --request GET \
--url https://api.usesimple.ai/api/v1/calls/{uuid} \
--header 'Authorization: <api-key>'import requests
url = "https://api.usesimple.ai/api/v1/calls/{uuid}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.usesimple.ai/api/v1/calls/{uuid}', 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.usesimple.ai/api/v1/calls/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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.usesimple.ai/api/v1/calls/{uuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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.usesimple.ai/api/v1/calls/{uuid}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usesimple.ai/api/v1/calls/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": 123,
"simple_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"from_number": "<string>",
"to_number": "<string>",
"status": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"duration": 123,
"created_at": "2023-11-07T05:31:56Z",
"prompt": {
"prompt_text": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"transcripts": [
{
"text": "<string>",
"role": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"function_name": "<string>",
"arguments": {}
}
],
"screen_pop_token": "<string>",
"call_prompt": "<string>",
"answered_by": "voicemail",
"updated_at": "2023-11-07T05:31:56Z",
"record": true,
"language": "en",
"transferred": true,
"handoff_metadata": {
"five9": {
"conversation_id": "<string>",
"tenant_name": "<string>",
"campaign_name": "<string>",
"transferred_at": "2023-11-07T05:31:56Z"
}
},
"direction": "<string>",
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"color": "<string>"
}
],
"voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"background_noise": "<string>",
"agent_speaks_first": true,
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_branch": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_commit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_branch_name": "<string>",
"external_identifiers": {},
"params": {},
"recording_presigned_url": "<string>",
"cart": {
"value": "<unknown>",
"checkout": {
"order_ids": [
"<string>"
]
}
},
"analyzers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"output_config": {
"type": "string",
"properties": {}
}
}
],
"analysis_results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"analyzer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"output_config": {},
"result": {}
}
],
"summary": {},
"keyterms": [
"<string>"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Get an AI Phone Call with the Simple AI API
Retrieve a specific Simple AI phone call, including its current status and the call data available to your organization.
curl --request GET \
--url https://api.usesimple.ai/api/v1/calls/{uuid} \
--header 'Authorization: <api-key>'import requests
url = "https://api.usesimple.ai/api/v1/calls/{uuid}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.usesimple.ai/api/v1/calls/{uuid}', 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.usesimple.ai/api/v1/calls/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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.usesimple.ai/api/v1/calls/{uuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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.usesimple.ai/api/v1/calls/{uuid}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usesimple.ai/api/v1/calls/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": 123,
"simple_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"from_number": "<string>",
"to_number": "<string>",
"status": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"duration": 123,
"created_at": "2023-11-07T05:31:56Z",
"prompt": {
"prompt_text": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"transcripts": [
{
"text": "<string>",
"role": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"function_name": "<string>",
"arguments": {}
}
],
"screen_pop_token": "<string>",
"call_prompt": "<string>",
"answered_by": "voicemail",
"updated_at": "2023-11-07T05:31:56Z",
"record": true,
"language": "en",
"transferred": true,
"handoff_metadata": {
"five9": {
"conversation_id": "<string>",
"tenant_name": "<string>",
"campaign_name": "<string>",
"transferred_at": "2023-11-07T05:31:56Z"
}
},
"direction": "<string>",
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"color": "<string>"
}
],
"voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"background_noise": "<string>",
"agent_speaks_first": true,
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_branch": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_commit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_branch_name": "<string>",
"external_identifiers": {},
"params": {},
"recording_presigned_url": "<string>",
"cart": {
"value": "<unknown>",
"checkout": {
"order_ids": [
"<string>"
]
}
},
"analyzers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"output_config": {
"type": "string",
"properties": {}
}
}
],
"analysis_results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"analyzer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"output_config": {},
"result": {}
}
],
"summary": {},
"keyterms": [
"<string>"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Path Parameters
Response
Successful Response
For native interactions this is the record creation time. For external-channel interactions this is the underlying session's ingestion time. Note: created_at sorting and the created_at_gte/created_at_lte filters order external-channel interactions by their call (leg start) time, not by this ingestion timestamp, so a returned created_at value may fall outside the requested filter window.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Opens this call's screen pop page at /screen-pop#<token>. It expires four hours after the call started.
Indicates how the call was answered - by a human, voicemail, or if there was no answer
voicemail, human, no_answer, unknown Timestamp when this call was last updated.
The language to use for the call - English (en) or Spanish (es)
en, es, ar Indicates if the call was transferred
Metadata about a transfer to an external provider.
Show child attributes
Show child attributes
The direction of the call (inbound/outbound)
Tags associated with the call
Show child attributes
Show child attributes
The ID of the voice used for the call
The background noise setting for the call
Whether the agent speaks first in the call
The ID of the agent used for the call. Null when the call is not associated with an agent.
The ID of the agent version used for the call. Null when the call is not associated with an agent.
The ID of the specific agent version snapshot used for the call. Null when the call is not associated with an agent.
The name of the agent version used for the call. Null when the call is not associated with an agent.
External identifiers associated with the call
Show child attributes
Show child attributes
Parameters associated with the call
Show child attributes
Show child attributes
The call's cart, when the agent version it ran on has a cart configured. Null otherwise.
Show child attributes
Show child attributes
List of analyzers configured for this call
Show child attributes
Show child attributes
Results from analyzers that have completed
Show child attributes
Show child attributes
The summary of the call if available
Key terms configured for the agent used on the call. Empty when there is no associated agent or no key terms are configured.