Get call transcript by call id

Request

Returns the transcript for the specified call as a JSON array of turns.

Requires the read_conversations OAuth scope.

Security

bearerAuth

Path

idstringrequired

The id of the call

Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:2.17

curl -i -X GET \
  'https://api.intercom.io/calls/{id}/transcript' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.17'

Responses

successful

Bodyapplication/json

Array [

start_timestring or number

Example:"0.0"

One of:

The start time of the turn, as a seconds offset from the start of the call. A string on calls transcribed by Amazon Transcribe, a number on Fin Voice calls.

string

end_timestring or number

Example:"3.00"

One of:

The end time of the turn, as a seconds offset from the start of the call. A string on calls transcribed by Amazon Transcribe, a number on Fin Voice calls.

string

speaker_labelstring

The diarization label for the speaker.

Example:"Teammate 1"

speakerstring

The diarization label for the speaker. Same value as speaker_label.

Example:"Teammate 1"

contentstring

The transcribed text spoken during this turn.

Example:"Hello, thanks for calling. How can I help today?"

speaker_typestring

The type of the speaker - either admin for a teammate or user for a contact. Absent on Fin Voice call transcripts and on calls transcribed before speaker attribution shipped, where only speaker_label identifies the speaker.

Example:"admin"

speaker_idstring

The id of the teammate or contact who is the speaker.

Example:"789"

article_sourcesArray of objects

Sources Fin cited during this turn. Only present on Fin Voice call transcripts.

Example:

[
  {
    "title": "Password Reset Guide",
    "entity_type": 120,
    "entity_id": "8185560"
  }
]

triggered_guidanceArray of objects

Guidance rules that Fin matched during this turn. Only present on Fin Voice call transcripts.

Example:

[
  {
    "match_type": "clarification",
    "rule_id": "3",
    "rule_text": "If the customer asks about pricing, ask which plan they're interested in before answering"
  }
]

]

Response

[
  {
    "start_time": "0.0",
    "end_time": "3.00",
    "speaker_label": "Teammate 1",
    "speaker": "Teammate 1",
    "content": "Hello, thanks for calling. How can I help today?",
    "speaker_type": "admin",
    "speaker_id": "789"
  },
  {
    "start_time": "3.00",
    "end_time": "9.00",
    "speaker_label": "User",
    "speaker": "User",
    "content": "I need help recovering access to my account.",
    "speaker_type": "user",
    "speaker_id": "6762f0dd1bb69f9f2193bb83"
  }
]