Skip to content

Commit a558dfa

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

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11151,21 +11151,31 @@ 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] Fin: "Howdy, this is Artem bot. How can I assist you today?"
11173+
[00:00:09] User: "Could you give me a description of Blue-Eyes White Dragon, please?"
11174+
[00:00:15] Fin: "The Blue-Eyes White Dragon is known for its high attack power of three thousand and defense of two thousand five hundred, making it one of the strongest normal monsters early on.
11175+
11176+
Would you like to hear more information about it?"
11177+
[00:00:30] User: "Ah no, could you send me up to a human now please?"
11178+
[00:00:35] Fin: "Our team will get back to you as soon as they can. Feel free to share more details before you hang up. Thank you for calling, and sorry I couldn't assist further."
1116911179
'404':
1117011180
description: Not Found
1117111181
content:

0 commit comments

Comments
 (0)