Enable HubSpot to use transcripts from a third-party platform as a part of its Conversation Intelligence feature.
crm.extensions_calling_transcripts.read
crm.extensions_calling_transcripts.write
POST
request to /crm/v3/extensions/calling/transcripts
. The request body will need to include the ID of the call engagement in HubSpot to attach the transcript to, along with a transcriptCreateUtterances
array containing the transcript data.
Field | Type | Description |
---|---|---|
engagementId * | String | The ID of the HubSpot call engagement to attach the transcript to. |
transcriptCreateUtterances * | Array | A list of objects containing the transcribed call dialogue. The available fields are listed in the table below. |
transcriptCreateUtterances
array. Fields marked with * are required.
Field | Type | Description |
---|---|---|
speaker * | Object | Contains the following information about the speaker:
|
text * | String | The transcribed text. |
languageCode | String | The speaker’s language. Default is en-US . |
startTimeMillis * | Integer | The starting time of the utterance, in milliseconds from the start of the call. Should be a positive number. |
endTimeMillis * | Integer | The end time of the utterance, in milliseconds from the start of the call. Should be greater than startTimeMillis . |
id
of the transcript, as generated by HubSpot.
GET
request to /crm/v3/extensions/calling/transcripts/{transcriptId}
.
The response will include the transcript details along with the ID of the associated call engagement.
Field | Type | Description |
---|---|---|
id | Integer | The ID of the transcript. |
engagementId | String | The ID of the HubSpot call engagement attached to the transcript. |
transcriptSource | String | The source of the transcript (will be set to INTEGRATOR_GENERATED ). |
createdAt | String | The datetime of when the transcript was created in HubSpot. |
transcriptUtterances | Array | A list of objects containing the transcribed call dialogue. |
speaker | Object | Contains information about the speaker, including their id , name , and an email address if previously provided. |
text | String | The transcribed text. |
languageCode | String | The speaker’s language. Default is en-US . |
startTimeMillis | Integer | The starting time of the utterance, in milliseconds from the start of the call. |
endTimeMillis | Integer | The end time of the utterance, in milliseconds from the start of the call. |
DELETE
request to /crm/v3/extensions/calling/transcripts/{transcriptId}
.