Intercom API (unofficial showcase)
POST/fin_voice/register

Register a Fin Voice call

Register a Fin Voice call with Intercom. This endpoint creates an external reference that links an external call identifier to an Intercom call and conversation.

The call can be from different sources:

  • AWS Connect (default)
  • Five9
  • Zoom Phone
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields
phone_numberstringrequired
Phone number in E.164 format for the call
call_idstringrequired
External call identifier from the call provider
sourcestringoptional
Source of the call. Can be "five9", "zoom_phone", or defaults to "aws_connect"
Allowed:five9zoom_phoneaws_connect
dataobjectoptional
Additional metadata about the call

4 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.
400bad request - missing phone_number or call_id
typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
409conflict - duplicate call registration
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 400 is returned: bad request - missing phone_number or call_id. A 409 is returned: conflict - duplicate call registration. Any other status is an error: Unexpected error.