Get Transcription and Summary

From docs
Revision as of 14:50, 21 July 2026 by Ashley DeBon (talk | contribs) (Get Transcription And Summary)
Jump to: navigation, search

Mobile_API »Get Transcription And Summary

Base URL

https://apimobile.callproof.com

Endpoint

/api/transcription-summary/{twilio_Id}

Purpose

Retrieves the AI call summary and transcription details for a Twilio call record. Returns the summary text and transcription content when available.

HTTP Method

GET

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

Parameter Type Required Description
twilio_Id integer Yes Unique identifier of the Twilio call record

Query Parameters

None.

Request Body

None.

Successful Response (200)

Returns summary and transcription details for the call.

Field Type Description
clientStatusCode integer Status indicator for the client (for example, 200)
user_id integer Identifier of the authenticated user
company_id integer Identifier of the authenticated user’s company
data object Transcription/summary payload
uri string Requested resource URI

data

Field Type Description
status boolean true when the lookup completed successfully
summary string AI-generated call summary text (falls back to stored transcription text when AI content is empty)
transcription array Parsed transcription segments when structured transcription text is available; otherwise an empty array
transcription_text string Plain transcription text fallback when structured segments are not available

Error Responses

Status Code Meaning
400 Bad Request – transcription/summary could not be retrieved
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – An error occurred while retrieving call transcription (for example, "Error while retrieving the twilio call transcription").
  • 401 – Authentication failed or the access token is missing/expired.