Call Details
curl --request GET \
--url https://app.luly.ai/api/v1/calls/{call_id} \
--header 'authorization: <authorization>'import requests
url = "https://app.luly.ai/api/v1/calls/{call_id}"
headers = {"authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {authorization: '<authorization>'}};
fetch('https://app.luly.ai/api/v1/calls/{call_id}', 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://app.luly.ai/api/v1/calls/{call_id}",
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: <authorization>"
],
]);
$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://app.luly.ai/api/v1/calls/{call_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.luly.ai/api/v1/calls/{call_id}")
.header("authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.luly.ai/api/v1/calls/{call_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"call_id": "d9cce3f3-23cf-4fa7-b62c-8be8119b8715",
"call_length": 0.75,
"batch_id": null,
"to": "+12223334444",
"from": "+17163511654",
"request_data": {
"phone_number": "+12223334444",
"wait": true,
"language": "ENG"
},
"completed": true,
"created_at": "2024-04-27T23:51:18.025251+00:00",
"inbound": false,
"queue_status": "completed",
"endpoint_url": "api.prod.luly.ai",
"max_duration": 30,
"error_message": null,
"variables": {
"now": "Sat Apr 27 2024 18:51:25 GMT-0500 (Central Daylight Time)",
"now_utc": "Sat, 27 Apr 2024 23:51:25 GMT",
"short_from": "7163511654",
"short_to": "2223334444",
"from": "+17163511654",
"to": "+12223334444",
"call_id": "d9cce3f3-23cf-4fa7-b62c-8be8119b8715",
"phone_number": "+12223334444",
"city": "SAN FRANCISCO",
"country": "US",
"state": "CA",
"zip": "12345",
"input": {
"date": "2024-04-28",
"rooms": 3
}
},
"answered_by": "human",
"record": false,
"recording_url": null,
"c_id": "d9cce3f3-23cf-4fa7-b62c-8be8119b8715",
"metadata": {},
"summary": "The call was a conversation between a hotel booking service assistant and a customer. The customer expressed interest in booking a hotel room for tomorrow and needing three rooms. The assistant booked book the reservation for three rooms for the next day. Then, the call ended with the assistant thanking the customer for choosing their service.",
"price": 0.068,
"started_at": "2024-04-27T23:51:25+00:00",
"local_dialing": false,
"call_ended_by": "ASSISTANT",
"pathway_logs": null,
"analysis_schema": null,
"analysis": null,
"concatenated_transcript": "user: Hello? \n assistant: Hi there! I'm calling from the hotel booking service. I'd love to help you with your reservation. Could you let me know what day you'd like to book your hotel for and how many rooms you'll need? \n user: Hopefully, tomorrow, I'm thinking. ...",
"transcripts": [
{
"id": 7395694,
"created_at": "2024-04-27T23:51:28.568385+00:00",
"text": "Hello?",
"user": "user",
"c_id": "d9cce3f3-23cf-4fa7-b62c-8be8119b8715",
"status": null,
"transcript_id": null
},
{
"id": 7395698,
"created_at": "2024-04-27T23:51:30.689815+00:00",
"text": "Hi there! I'm calling from the hotel booking service. I'd love to help you with your reservation. Could you let me know what day you'd like to book your hotel for and how many rooms you'll need?",
"user": "assistant",
"c_id": "d9cce3f3-23cf-4fa7-b62c-8be8119b8715",
"status": null,
"transcript_id": "c58ee235-0763-4ae1-a734-17fbba505c52"
},
//...
],
"status": "completed",
"corrected_duration": "45",
"end_at": "2024-04-27T23:52:10.000Z"
}
Calls
Call Details
Retrieve detailed information, metadata and transcripts for a call.
GET
/
v1
/
calls
/
{call_id}
Call Details
curl --request GET \
--url https://app.luly.ai/api/v1/calls/{call_id} \
--header 'authorization: <authorization>'import requests
url = "https://app.luly.ai/api/v1/calls/{call_id}"
headers = {"authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {authorization: '<authorization>'}};
fetch('https://app.luly.ai/api/v1/calls/{call_id}', 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://app.luly.ai/api/v1/calls/{call_id}",
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: <authorization>"
],
]);
$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://app.luly.ai/api/v1/calls/{call_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.luly.ai/api/v1/calls/{call_id}")
.header("authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.luly.ai/api/v1/calls/{call_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"call_id": "d9cce3f3-23cf-4fa7-b62c-8be8119b8715",
"call_length": 0.75,
"batch_id": null,
"to": "+12223334444",
"from": "+17163511654",
"request_data": {
"phone_number": "+12223334444",
"wait": true,
"language": "ENG"
},
"completed": true,
"created_at": "2024-04-27T23:51:18.025251+00:00",
"inbound": false,
"queue_status": "completed",
"endpoint_url": "api.prod.luly.ai",
"max_duration": 30,
"error_message": null,
"variables": {
"now": "Sat Apr 27 2024 18:51:25 GMT-0500 (Central Daylight Time)",
"now_utc": "Sat, 27 Apr 2024 23:51:25 GMT",
"short_from": "7163511654",
"short_to": "2223334444",
"from": "+17163511654",
"to": "+12223334444",
"call_id": "d9cce3f3-23cf-4fa7-b62c-8be8119b8715",
"phone_number": "+12223334444",
"city": "SAN FRANCISCO",
"country": "US",
"state": "CA",
"zip": "12345",
"input": {
"date": "2024-04-28",
"rooms": 3
}
},
"answered_by": "human",
"record": false,
"recording_url": null,
"c_id": "d9cce3f3-23cf-4fa7-b62c-8be8119b8715",
"metadata": {},
"summary": "The call was a conversation between a hotel booking service assistant and a customer. The customer expressed interest in booking a hotel room for tomorrow and needing three rooms. The assistant booked book the reservation for three rooms for the next day. Then, the call ended with the assistant thanking the customer for choosing their service.",
"price": 0.068,
"started_at": "2024-04-27T23:51:25+00:00",
"local_dialing": false,
"call_ended_by": "ASSISTANT",
"pathway_logs": null,
"analysis_schema": null,
"analysis": null,
"concatenated_transcript": "user: Hello? \n assistant: Hi there! I'm calling from the hotel booking service. I'd love to help you with your reservation. Could you let me know what day you'd like to book your hotel for and how many rooms you'll need? \n user: Hopefully, tomorrow, I'm thinking. ...",
"transcripts": [
{
"id": 7395694,
"created_at": "2024-04-27T23:51:28.568385+00:00",
"text": "Hello?",
"user": "user",
"c_id": "d9cce3f3-23cf-4fa7-b62c-8be8119b8715",
"status": null,
"transcript_id": null
},
{
"id": 7395698,
"created_at": "2024-04-27T23:51:30.689815+00:00",
"text": "Hi there! I'm calling from the hotel booking service. I'd love to help you with your reservation. Could you let me know what day you'd like to book your hotel for and how many rooms you'll need?",
"user": "assistant",
"c_id": "d9cce3f3-23cf-4fa7-b62c-8be8119b8715",
"status": null,
"transcript_id": "c58ee235-0763-4ae1-a734-17fbba505c52"
},
//...
],
"status": "completed",
"corrected_duration": "45",
"end_at": "2024-04-27T23:52:10.000Z"
}
Headers
string
required
Your API key for authentication.
string
Use your own Twilio account and only return inbound numbers associated with
that account sid (optional).
Path Parameters
string
required
The unique identifier of the call for which you want to retrieve detailed
information.
Response
array of objects
An array of phrases spoken during the call.Each index includes:
idcreated_attextuser(can beuser,assistant,robot, oragent-action)
number
The unique identifier for the call.
number
The length of the call in minutes.
string
Number that the person was transferred to.
string
If the call is part of a batch, it’s
batch_id will be here.string
The phone number that received the call.
string
The phone number that made the call.
object
Details about parameters in the original api request.
boolean
Whether the call has been completed. If it differs from the value of
‘queue_status’, this will be the most up-to-date status.
boolean
Whether the call was inbound or outbound. Will be false for outbound calls.
string
The timestamp for when the call request was created.
string
The time the call was connected.
string
The time that the call will automatically be ended at if it’s still connected
(because of
max_duration).string
The status of the call. During extremely high volume periods, calls may be queued for a short period of time before being dispatched.
Statuses:
Statuses:
Progresses through the following stages:
new: An API request has been received.queued: Call pararameters have been validated and authentication succeeded.allocated: Extremely brief, the call is being dispatched.started: The phone call is live and in progress.complete: The phone call has ended successfully.
pre_queue_error: An error occurred before the call was queued. Invalid parameters generally cause this.queue_error: Error occurred while the call was queued. Ex. Valid phone number but to an unserviced area.call_error: Error occurred during live call. May be caused by transferring to an invalid phone number or an unforeseen error.complete_error: Error occurred after the call was completed. Ex. A post-call webhook failed.
error_message field.string
The url of the deployment that the call was handled on. Will always be
“api.prod.luly.ai” unless the call was handled on a custom Enterprise
deployment.
number
The maximum length of time the call was allowed to last. If the call would
exceed this length, it’s ended early.
string
If an error occurs, this will contain a description of the error. Otherwise,
it will be null.
object
Variables created during the call - both system variables as well as generated with
dynamic_data or Custom Tools.For example, if you used a dynamic_data API request to generate a variable called appointment_time, you would see it here (both the agent’s inputs and the response variables).string
If
answered_by_enabled was set to true in the original API request, this field contains one of the following values:human: The call was answered by a human.voicemail: The call was answered by an answering machine or voicemail.unknown: There was not enough audio at the start of the call to make a determination.no-answer: The call was not answered.null: Not enabled, or still processing the result.
answered_by_enabled was set to true, then webhooks may take up to a minute to fire after the call ends while the call audio is processed.Notes:
Notes:
- Determinations are based on audio from the first five seconds of the phone call.
unknownis most likely a human, especially if there are multiple transcripts.- Optimize calls for accurate results by getting humans to respond in the first five seconds:
- Increase
speedinvoice_settings - Use with
wait_for_greeting - Use a short greeting in
first_sentencesuch as"Hello?"or"Hi, is this {{name}}?"
- Increase
boolean
Whether the call audio was recorded.
string
The URL of the recording of the call. Only available if record was set to true
in the original API request.
object
Metadata about the call. This can include information about the client, customer, or any other data you want to include.This is identical to the
metadata that was set in the original API request to send the call.string
A short summary of the call based off of the transcript that’s generated when
the call ends.
number
The cost of the call in USD.
boolean
Whether Local Dialing was enabled for your account at the time of the call.
string
Whether the call was ended by Luly’s system or the other end of the line.
ASSISTANT: The agent ended the call.USER: The user ended the call.
string
Pathways calls will have extra logs here that have much more detailed
information about the chosen nodes and internal reasoning throughout the flow.
object
The provided structure used in the post call analysis. This is the raw
skeleton describing the data structure that will be filled in once the call
ends.
object
The data filled in by the post call analysis. This is the raw data that was
generated by the analysis schema.
string
A single string containing all of the text from the call. Excludes system
messages and auto-generated data.
array of objects
An array of phrases spoken during the call.Each index includes:
idcreated_attextuser(can beuser,assistant,robot, oragent-action)
string
The status of the call. This is the most up-to-date status of the call, but is
only present for calls that have been successfully created.
string
The corrected duration of the call in seconds. This is the actual length of
the call, not the
max_duration.{
"call_id": "d9cce3f3-23cf-4fa7-b62c-8be8119b8715",
"call_length": 0.75,
"batch_id": null,
"to": "+12223334444",
"from": "+17163511654",
"request_data": {
"phone_number": "+12223334444",
"wait": true,
"language": "ENG"
},
"completed": true,
"created_at": "2024-04-27T23:51:18.025251+00:00",
"inbound": false,
"queue_status": "completed",
"endpoint_url": "api.prod.luly.ai",
"max_duration": 30,
"error_message": null,
"variables": {
"now": "Sat Apr 27 2024 18:51:25 GMT-0500 (Central Daylight Time)",
"now_utc": "Sat, 27 Apr 2024 23:51:25 GMT",
"short_from": "7163511654",
"short_to": "2223334444",
"from": "+17163511654",
"to": "+12223334444",
"call_id": "d9cce3f3-23cf-4fa7-b62c-8be8119b8715",
"phone_number": "+12223334444",
"city": "SAN FRANCISCO",
"country": "US",
"state": "CA",
"zip": "12345",
"input": {
"date": "2024-04-28",
"rooms": 3
}
},
"answered_by": "human",
"record": false,
"recording_url": null,
"c_id": "d9cce3f3-23cf-4fa7-b62c-8be8119b8715",
"metadata": {},
"summary": "The call was a conversation between a hotel booking service assistant and a customer. The customer expressed interest in booking a hotel room for tomorrow and needing three rooms. The assistant booked book the reservation for three rooms for the next day. Then, the call ended with the assistant thanking the customer for choosing their service.",
"price": 0.068,
"started_at": "2024-04-27T23:51:25+00:00",
"local_dialing": false,
"call_ended_by": "ASSISTANT",
"pathway_logs": null,
"analysis_schema": null,
"analysis": null,
"concatenated_transcript": "user: Hello? \n assistant: Hi there! I'm calling from the hotel booking service. I'd love to help you with your reservation. Could you let me know what day you'd like to book your hotel for and how many rooms you'll need? \n user: Hopefully, tomorrow, I'm thinking. ...",
"transcripts": [
{
"id": 7395694,
"created_at": "2024-04-27T23:51:28.568385+00:00",
"text": "Hello?",
"user": "user",
"c_id": "d9cce3f3-23cf-4fa7-b62c-8be8119b8715",
"status": null,
"transcript_id": null
},
{
"id": 7395698,
"created_at": "2024-04-27T23:51:30.689815+00:00",
"text": "Hi there! I'm calling from the hotel booking service. I'd love to help you with your reservation. Could you let me know what day you'd like to book your hotel for and how many rooms you'll need?",
"user": "assistant",
"c_id": "d9cce3f3-23cf-4fa7-b62c-8be8119b8715",
"status": null,
"transcript_id": "c58ee235-0763-4ae1-a734-17fbba505c52"
},
//...
],
"status": "completed",
"corrected_duration": "45",
"end_at": "2024-04-27T23:52:10.000Z"
}