Skip to content

Calls

Retrieve a call analysis

GET/v1/calls/{call_id}/analysis

Get the post-call AI analysis (summary and outcome) for a call.

On this page

Headers

AuthorizationstringRequired
ApiKey $ENTROVOX_KEY. Keys are issued per organization.

Path parameters

call_idstringRequired

Returns

200 OKSuccessful Response

analysis_duration_msinteger or nullMay be absent
call_idstringAlways present
call_outcomestringAlways present
call_summarystring or nullMay be absent
callback_action_takenbooleanMay be absent

Default false

callback_datetimestring (date-time) or nullMay be absent
callback_detectedbooleanMay be absent

Default false

callback_notesstring or nullMay be absent
competitors_mentionedarray of stringMay be absent
created_atstring (date-time)Always present
dnc_action_takenbooleanMay be absent

Default false

dnc_detectedbooleanMay be absent

Default false

dnc_phrasesarray of stringMay be absent
error_messagestring or nullMay be absent
extracted_dataobjectMay be absent
Free-form key and value pairs.
follow_up_actionsarray of stringMay be absent
idstringAlways present
model_usedstring or nullMay be absent
not_available_detectedbooleanMay be absent

Default false

not_available_whostring or nullMay be absent
objectionsarray of objectMay be absent
organization_idstringAlways present
outcome_confidencenumber or nullMay be absent
outcome_reasoningstring or nullMay be absent
overall_sentimentstring or nullMay be absent
prompt_versionstring or nullMay be absent
sentiment_scorenumber or nullMay be absent
token_countinteger or nullMay be absent
updated_atstring (date-time)Always present
wrong_number_action_takenbooleanMay be absent

Default false

wrong_number_detectedbooleanMay be absent

Default false

Errors

  • 404CALL_ANALYSIS_NOT_FOUND

    The call exists but its analysis is not written yet. It is pending until call.analysis.completed, or until analysis_status is completed.

    Retry after the time in details.next_attempt_local when present. Otherwise retry when the blocking condition ends, as the meaning says.

  • 404CALL_NOT_FOUND

    No call with that id in your organization.

    Retrying will fail the same way. Fix the request, or contact us.

  • 422VALIDATION_ERROR

    A field is missing or invalid, such as a bad E.164 phone or a missing external_id. param names the field.

    Retrying will fail the same way. Fix the request, or contact us.

Any request can also return AUTHENTICATION_REQUIRED, TOKEN_INVALID, API_KEY_EXPIRED, RATE_LIMIT_EXCEEDED or INTERNAL_ERROR.