Skip to content

Commit cf662bb

Browse files
committed
docs(api): update transcript endpoint to return text/plain with attachment example
1 parent 903555b commit cf662bb

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11151,21 +11151,33 @@ paths:
1115111151
- Calls
1115211152
operationId: showCallTranscript
1115311153
description: |
11154-
Returns the transcript for the specified call. If no transcript exists, an array with a single empty object is returned: `[{}]`.
11154+
Returns the transcript for the specified call as a downloadable text file.
1115511155
responses:
1115611156
'200':
1115711157
description: successful
11158+
headers:
11159+
Content-Disposition:
11160+
description: File attachment directive and suggested filename for the transcript
11161+
schema:
11162+
type: string
11163+
example: "attachment; filename=transcription_data-2025-07-17.txt"
1115811164
content:
11159-
application/json:
11160-
examples:
11161-
no_transcript:
11162-
value:
11163-
- {}
11165+
text/plain:
1116411166
schema:
11165-
type: array
11166-
items:
11167-
type: object
11168-
additionalProperties: true
11167+
type: string
11168+
description: Transcript text
11169+
examples:
11170+
transcript_txt:
11171+
value: |-
11172+
[00:00:03] Teammate 1: "Hello, thanks for calling. How can I help today?"
11173+
[00:00:09] User: "I need help recovering access to my account."
11174+
[00:00:15] Teammate 1: "I can help with that. For security, I’ll ask a few generic verification questions."
11175+
[00:00:22] User: "Okay."
11176+
[00:00:28] Teammate 1: "Please confirm general details on the account (no sensitive data over this call)."
11177+
[00:00:35] User: "I can provide non-sensitive info."
11178+
[00:00:41] Teammate 1: "Thank you. I’ll initiate a standard account recovery process and send the next steps."
11179+
[00:00:48] User: "Great, thanks."
11180+
[00:00:53] Teammate 1: "You should receive a message shortly with instructions to complete recovery."
1116911181
'404':
1117011182
description: Not Found
1117111183
content:

0 commit comments

Comments
 (0)