Ashley DeBon: /* Successful Response (200) */

2026-07-21T14:51:23Z

‎Successful Response (200)

Ashley DeBon: /* Get Transcription And Summary */

2026-07-21T14:50:52Z

‎Get Transcription And Summary

Ashley DeBon: Created page with "== Get Transcription And Summary == === Base URL === https://apimobile.callproof.com === Endpoint === /api/transcription-summary/{twilio_Id} === Purpose === Retrieves the A..."

2026-07-21T14:50:32Z

Created page with "== Get Transcription And Summary == === Base URL === https://apimobile.callproof.com === Endpoint === /api/transcription-summary/{twilio_Id} === Purpose === Retrieves the A..."

New page

== 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 ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
{| class="wikitable"
! 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.

{| class="wikitable"
! 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 ====
{| class="wikitable"
! Field !! Type !! Description
|-
| status || boolean || <code>true</code> 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 ===
{| class="wikitable"
! 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.

← Older revision		Revision as of 14:50, 21 July 2026
Line 1:		Line 1:
−	== Get Transcription And Summary ==	+	== [[Mobile_API]] »Get Transcription And Summary ==

	=== Base URL ===		=== Base URL ===

@@ Line 37: / Line 37: @@
 ==== Request Body ====
 None.
 === Successful Response (200) ===

Get Transcription and Summary - Revision history

Ashley DeBon: /* Successful Response (200) */

Ashley DeBon: /* Get Transcription And Summary */

Ashley DeBon: Created page with "== Get Transcription And Summary == === Base URL === https://apimobile.callproof.com === Endpoint === /api/transcription-summary/{twilio_Id} === Purpose === Retrieves the A..."