Skip to content

Commit 603c104

Browse files
committed
docs(api): add POST /calls/search (list calls with transcripts)
1 parent 60c620f commit 603c104

File tree

1 file changed

+101
-0
lines changed

1 file changed

+101
-0
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11180,6 +11180,107 @@ paths:
1118011180
message: Not Found
1118111181
schema:
1118211182
"$ref": "#/components/schemas/error"
11183+
"/calls/search":
11184+
post:
11185+
summary: List calls with transcripts
11186+
parameters:
11187+
- name: Intercom-Version
11188+
in: header
11189+
schema:
11190+
"$ref": "#/components/schemas/intercom_version"
11191+
tags:
11192+
- Calls
11193+
operationId: listCallsWithTranscripts
11194+
description: |
11195+
Retrieve calls by a list of conversation ids and include transcripts when available.
11196+
A maximum of 20 `conversation_ids` can be provided. If none are provided or more than 20 are provided, a 400 error is returned.
11197+
requestBody:
11198+
required: true
11199+
content:
11200+
application/json:
11201+
schema:
11202+
type: object
11203+
required:
11204+
- conversation_ids
11205+
properties:
11206+
conversation_ids:
11207+
type: array
11208+
description: A list of conversation ids to fetch calls for. Maximum 20.
11209+
minItems: 1
11210+
maxItems: 20
11211+
items:
11212+
type: string
11213+
examples:
11214+
example:
11215+
value:
11216+
conversation_ids:
11217+
- "64619700005694"
11218+
- "64619700005695"
11219+
responses:
11220+
'200':
11221+
description: successful
11222+
content:
11223+
application/json:
11224+
examples:
11225+
successful:
11226+
value:
11227+
type: list
11228+
data:
11229+
- type: call
11230+
id: "123"
11231+
conversation_id: "64619700005694"
11232+
transcript:
11233+
- {}
11234+
transcript_status: completed
11235+
schema:
11236+
type: object
11237+
properties:
11238+
type:
11239+
type: string
11240+
example: list
11241+
data:
11242+
type: array
11243+
items:
11244+
allOf:
11245+
- "$ref": "#/components/schemas/call"
11246+
- type: object
11247+
properties:
11248+
transcript:
11249+
type: array
11250+
description: The call transcript if available, otherwise an empty array.
11251+
items:
11252+
type: object
11253+
additionalProperties: true
11254+
transcript_status:
11255+
type: string
11256+
nullable: true
11257+
description: The status of the transcript if available.
11258+
'400':
11259+
description: Bad Request
11260+
content:
11261+
application/json:
11262+
examples:
11263+
too_many_ids:
11264+
value:
11265+
type: error.list
11266+
errors:
11267+
- code: conversation_id_limit_exceeded
11268+
message: "A list of up to 20 conversation IDs is required"
11269+
schema:
11270+
"$ref": "#/components/schemas/error"
11271+
'401':
11272+
description: Unauthorized
11273+
content:
11274+
application/json:
11275+
examples:
11276+
Unauthorized:
11277+
value:
11278+
type: error.list
11279+
errors:
11280+
- code: unauthorized
11281+
message: Access Token Invalid
11282+
schema:
11283+
"$ref": "#/components/schemas/error"
1118311284
'401':
1118411285
description: Unauthorized
1118511286
content:

0 commit comments

Comments
 (0)