Intercom API (unofficial showcase)
GET/fin_voice/collect/{id}

Collect Fin Voice call by ID

Retrieve information about a Fin Voice call using the external reference ID.

1 parameter
idintegerrequired
The external reference ID

3 status codes
200successful
idintegeroptional
The unique identifier for the external reference
app_idintegeroptional
The workspace identifier
user_phone_numberstringoptional
Phone number in E.164 format for the call
statusstringoptional
Status of the call. Can be "registered", "in-progress", or a resolution state
intercom_call_idstringoptional
The Intercom call identifier, if the call has been matched
external_call_idstringoptional
The external call identifier from the call provider
intercom_conversation_idstringoptional
The Intercom conversation identifier, if a conversation has been created
call_transcriptarray<object>optional
Array of transcript entries for the call
call_summarystringoptional
Summary of the call conversation, truncated to 256 characters. Empty string if no summary available.
intentarray<object>optional
Array of intent classifications for the call
dataobjectoptional
The metadata object supplied when the call was registered, returned verbatim. Empty object when none was supplied.
404not found - external reference not found or not matched
typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
defaultUnexpected error
typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 404 is returned: not found - external reference not found or not matched. Any other status is an error: Unexpected error.