Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get a call analysis

Returns one call analysis by its id from a list response. status tracks the analysis lifecycle; overallScore and analyzedAt stay null until it completes. Requires the calls scope.

GET/customer/phone-systems/{phoneSystemId}/call-analyses/{id}
Authorization
X-API-KeyAPI key · headerrequired
API key (sk_phones_* prefix) for programmatic access
Path parameters
phoneSystemIdstring<uuid>required
Phone system identifier, discoverable via the accessible phone systems operation.
idstring<uuid>required
Call analysis identifier from a list response.
Responses
200The call analysis.
analyzedAtstring<date-time> | anyrequired
When the analysis completed.
Show properties
Any of:
string<date-time>
string<date-time>
any
any
callLogIdstring<uuid>required
Analyzed call log — the callLogId carried by webhook payloads.
callSidstringrequired
Call identifier of the analyzed call, as delivered in webhook payloads.
coachingTipsstring[]required
Actionable coaching suggestions from the analysis.
createdAtstring<date-time>required
When the row was created; lists are ordered by this, descending.
idstring<uuid>required
Call analysis identifier.
overallScorenumber | anyrequired
Overall score (0-100); null until the analysis completes.
Show properties
Any of:
number
number
any
any
phoneSystemIdstring<uuid>required
Phone system the analyzed call belongs to.
statusstringrequired
Analysis lifecycle status.
Allowed:pendingprocessingcompletedfailed
400Validation failure: id is not a UUID.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
401The API key is missing, malformed, expired, or revoked.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
403The key lacks the calls:read scope, or is not a tenant API key.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
404No such call analysis in this phone system — a nonexistent id and an id belonging to another phone system are indistinguishable — or the phone system itself is not covered by the key.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
Request
curl -X GET "https://api.steerphones.com/v1/customer/phone-systems/%3Cuuid%3E/call-analyses/%3Cuuid%3E" \
  -H "X-API-Key: YOUR_API_KEY"
Response
{
  "analyzedAt": "2024-01-01T00:00:00Z",
  "callLogId": "<uuid>",
  "callSid": "string",
  "coachingTips": [
    "string"
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "id": "<uuid>",
  "overallScore": 0,
  "phoneSystemId": "<uuid>",
  "status": "pending"
}