Learn how to log call recordings and their associated transcripts in HubSpot.
.WAV
, .FLAC
, and .MP4
audio files will be transcribed.range
header and return a 206 partial content
(not a 200
server code).externalId
: the unique ID associated with a call URL, provided as a path parameter. This will correspond to the same parameter you include in the metadata of your POST
request to the engagements API, which you can then use in your app’s backend to associate with the recording URL.externalAccountId
: a unique ID associated with the HubSpot account that made the call engagement, provided as a query parameter. You can use this parameter along with the externalId to identify the call recording.appId
: the ID of your app, provided as a query parameter.authenticatedUrl
field that provides the recording URL.
POST
request using your app’s ID to /crm/v3/extensions/calling/{appId}/settings/recording
. In the request body, provide the URL of your endpoint in the urlToRetrieveAuthedRecording
field.
%s
character sequence, which HubSpot will substitute with the externalId
of the engagement when calling your endpoint. The %s
character sequence can be located anywhere in your URL.POST
request, including the https://
prefix.PATCH
request to the same HubSpot endpoint above and provide an updated value for urlToRetrieveAuthedRecording
.
POST
request to /crm/v3/objects/calls
. In the request body, include the engagement data within the properties
field.
The hs_call_external_id
, hs_call_external_account_id
, hs_call_app_id
, and hs_call_source
properties are required to ensure that HubSpot can fetch the authenticated recording URL.
PUT
request to /crm/v3/objects/calls/{callId}/associations/{toObjectType}/{toObjectId}/{associationType}
.
For example, if the ID of the logged call you created is 17591596434
, the ID of the contact you want to associate it with is 104901
, and the ID of the association type is 194
, your request URL would be:
/crm/v3/objects/calls/17591596434/associations/contacts/104901/194
When one of your app’s users navigates to the associated record timeline to view the engagement, HubSpot will call the endpoint you configured to serve the authenticated recording URL. For example, to retrieve the recording URL associated with the example engagement above, HubSpot would make a GET
request to:
https://app-test.com/retrieve/authenticated/recordings/test-call-01?appId=app-101&externalAccountId=test-account-01
POST
request to /crm/v3/extensions/calling/recordings/ready
. In the request body, include the call ID in the engagementId
field.