curl --request GET \
--url https://api.goyappr.com/calls/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.goyappr.com/calls/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.goyappr.com/calls/{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://api.goyappr.com/calls/{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: Bearer <token>"
],
]);
$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.goyappr.com/calls/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.goyappr.com/calls/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goyappr.com/calls/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"from": "<string>",
"to": "<string>",
"direction": "<string>",
"status": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"duration_seconds": 123,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"ended_by": "caller",
"disconnect_reason": "<string>",
"transferred_at": "2023-11-07T05:31:56Z",
"transfer_target": "<string>",
"recording_url": "<string>",
"disposition": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"color": "#22c55e",
"position": 123,
"is_protected": true,
"created_at": "2023-11-07T05:31:56Z"
},
"lead": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone_number": "+972501234567",
"name": "<string>",
"email": "jsmith@example.com",
"source": "api",
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"color": "<string>",
"sort_order": 123,
"created_at": "2023-11-07T05:31:56Z"
}
],
"long_term_context": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"summary": "<string>",
"transcript": [
{
"role": "agent",
"text": "<string>",
"start": 123,
"end": 123
}
],
"extracted_data": {},
"tool_calls": [
{
"tool_name": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"kind": "webhook_tool",
"node": {
"id": "<string>",
"name": "<string>",
"type": "tool_call"
},
"tool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "<string>",
"action": "<string>",
"integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"arg_sources": {},
"request": {
"body": "<unknown>",
"method": "<string>",
"url": "<string>",
"headers": {}
},
"response": {
"success": true,
"response_preview": "<string>",
"raw_response_preview": "<string>",
"error": "<string>",
"duration_ms": 123
}
}
],
"events": [
{
"type": "call_initiated",
"timestamp": "2023-11-07T05:31:56Z",
"data": {}
}
],
"flow_trace": {
"started_at": "2023-11-07T05:31:56Z",
"steps": [
{
"step_id": "<string>",
"step_type": "start",
"entered_at": "2023-11-07T05:31:56Z",
"eval_decisions": [
{
"decision": "<string>",
"decided_at": "2023-11-07T05:31:56Z",
"turn_id": 123,
"reasoning": "<string>"
}
],
"step_name": "<string>",
"reason": "<string>",
"tool_call": {
"kind": "tool_call",
"tool_name": "<string>",
"status": "success",
"tool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "<string>",
"action": "<string>",
"integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"args": {},
"arg_sources": {},
"response_preview": "<string>",
"raw_response_preview": "<string>",
"error": "<string>",
"duration_ms": 123
}
}
],
"agent_speaks_first": true,
"first_step_id": "<string>"
}
}Get Call
curl --request GET \
--url https://api.goyappr.com/calls/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.goyappr.com/calls/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.goyappr.com/calls/{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://api.goyappr.com/calls/{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: Bearer <token>"
],
]);
$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.goyappr.com/calls/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.goyappr.com/calls/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goyappr.com/calls/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"from": "<string>",
"to": "<string>",
"direction": "<string>",
"status": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"duration_seconds": 123,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"ended_by": "caller",
"disconnect_reason": "<string>",
"transferred_at": "2023-11-07T05:31:56Z",
"transfer_target": "<string>",
"recording_url": "<string>",
"disposition": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"color": "#22c55e",
"position": 123,
"is_protected": true,
"created_at": "2023-11-07T05:31:56Z"
},
"lead": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone_number": "+972501234567",
"name": "<string>",
"email": "jsmith@example.com",
"source": "api",
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"color": "<string>",
"sort_order": 123,
"created_at": "2023-11-07T05:31:56Z"
}
],
"long_term_context": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"summary": "<string>",
"transcript": [
{
"role": "agent",
"text": "<string>",
"start": 123,
"end": 123
}
],
"extracted_data": {},
"tool_calls": [
{
"tool_name": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"kind": "webhook_tool",
"node": {
"id": "<string>",
"name": "<string>",
"type": "tool_call"
},
"tool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "<string>",
"action": "<string>",
"integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"arg_sources": {},
"request": {
"body": "<unknown>",
"method": "<string>",
"url": "<string>",
"headers": {}
},
"response": {
"success": true,
"response_preview": "<string>",
"raw_response_preview": "<string>",
"error": "<string>",
"duration_ms": 123
}
}
],
"events": [
{
"type": "call_initiated",
"timestamp": "2023-11-07T05:31:56Z",
"data": {}
}
],
"flow_trace": {
"started_at": "2023-11-07T05:31:56Z",
"steps": [
{
"step_id": "<string>",
"step_type": "start",
"entered_at": "2023-11-07T05:31:56Z",
"eval_decisions": [
{
"decision": "<string>",
"decided_at": "2023-11-07T05:31:56Z",
"turn_id": 123,
"reasoning": "<string>"
}
],
"step_name": "<string>",
"reason": "<string>",
"tool_call": {
"kind": "tool_call",
"tool_name": "<string>",
"status": "success",
"tool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "<string>",
"action": "<string>",
"integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"args": {},
"arg_sources": {},
"response_preview": "<string>",
"raw_response_preview": "<string>",
"error": "<string>",
"duration_ms": 123
}
}
],
"agent_speaks_first": true,
"first_step_id": "<string>"
}
}Authorizations
Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.
Path Parameters
Response
Full call details
The metadata object you attached at POST /calls. Empty object {} if no metadata was provided at call creation.
Who terminated the call. First-write-wins (a specific value like 'system' from voicemail detection is not overwritten by a later generic 'caller').
caller, agent, system, unknown User-friendly reason the call ended (e.g. 'Completed', 'Voicemail detected', or 'Your Telnyx account refused the call…' when your own Telnyx account refused a call from one of its numbers). First-write-wins.
When the call was transferred (set only if status='transferred').
E.164 number the call was transferred to.
Permanent signed URL for the call recording. Opens directly in a browser or audio player — redirects (302) to the audio file. No additional authentication required.
Full Disposition object. Present only when a disposition has been assigned.
Show child attributes
Show child attributes
Full Lead object including long_term_context and tags. Present only when a matched lead exists.
Show child attributes
Show child attributes
AI-generated call summary. Present only when available.
Full call transcript, ordered by time. Present only when available.
Show child attributes
Show child attributes
Structured fields extracted post-call by the agent's extraction_parameters. Present only when extraction ran and produced at least one value.
Paired request/response objects for each tool invocation during the call. Easier to consume than raw events. Auth-related headers (Authorization, tokens, keys) are redacted as [REDACTED].
Show child attributes
Show child attributes
Full ordered event stream for the call. Low-level — for flow agents prefer flow_trace (below). Auth headers in tool_called events are redacted.
Show child attributes
Show child attributes
Present only on flow-agent calls (agent.type='flow'). For prompt agents this field is omitted.
Structured view of the call's path through the flow graph, built from the underlying flow_* events.
For flow agents tool_calls[] is always empty — flow tool nodes use a separate dispatch path that
emits flow_tool_result events (surfaced inline on each flow_trace.steps[].tool_call).
Show child attributes
Show child attributes