curl --request GET \
--url https://api.example.com/v1/core/recordings/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "<string>",
"dateCreated": "<string>",
"deleted": true,
"transcriptionStatus": "RECORDING",
"processingStatus": "in-progress",
"processingStage": "done",
"processingErrors": [
"bookmarking-failed",
"summary-failed"
],
"recordErrors": [
"paused-early"
],
"processingError": "<string>",
"rawAudioPath": "<string>",
"processedAudioPath": "<string>",
"lastProcessedAudio": "<string>",
"organizationId": "<string>",
"teamId": "<string>",
"userId": "<string>",
"locked": true,
"terminatedUngraciously": true,
"originalDeviceId": "<string>",
"codeVersion": "<string>",
"lock": true,
"splitLock": true,
"mergeLock": true,
"splitRetryNeeded": true,
"organizationName": "<string>",
"repFirstName": "<string>",
"repLastName": "<string>",
"speakerMap": {},
"mergeRetryNeeded": true,
"redactedTranscript": "<string>",
"confidence": 123,
"error": "<string>",
"jumpToTags": [
{
"text": "<string>",
"timestampInMilliseconds": 123,
"endTimestampInMilliseconds": 123,
"type": "<string>",
"types": [
"<string>"
],
"preview": "<string>",
"previewStartTimestampInMilliseconds": 123,
"previewChunkId": "<string>",
"bookmarkConfigId": "<string>",
"advancedBookmarkId": "<string>",
"advancedBookmarkConfirmed": true,
"repResponseId": "<string>",
"botCommentId": "<string>",
"botCommentThreadId": "<string>",
"confirmationQuestion": "<string>",
"classificationQuestions": [
{
"text": "<string>",
"result": true
}
],
"responseDetails": "<string>",
"responseJudgement": "<string>",
"exchangeStart": 123,
"exchangeEnd": 123,
"manualLabelId": "<string>",
"identifier": "<string>",
"speakerTag": "<string>",
"similarityScore": 123,
"llmConfirmed": true,
"llmJustification": "<string>",
"llmBookmarkingAnswer": "<string>"
}
],
"jumpToTagsWordsOnly": [
"<string>"
],
"lastUpdatedJumpToTags": "<string>",
"manualLabelBookmarkConfigIds": [
"<string>"
],
"result": "<string>",
"title": "<string>",
"notes": "<string>",
"durationInMilliseconds": 123,
"discoverable": true,
"isPrivate": true,
"detected_language": "<string>",
"trendingScore": 123,
"starCount": 123,
"viewCount": 123,
"uniqueViewCount": 123,
"deletedDate": "<string>",
"deletedPermanently": true,
"originalRecordingId": "<string>",
"enableAutomaticSplit": true,
"offsetFromOriginalRecordingMs": 123,
"conversationType": "<string>",
"debriefResponses": {},
"debriefQuestions": [
{
"id": "<string>",
"prompt": "<string>",
"responseType": "DATE_RESPONSE",
"responseConfig": {
"includeTime": true,
"required": true,
"latestAllowableDate": "<string>",
"earliestAllowableDate": "<string>"
},
"sortValue": 123,
"promptDetails": "<string>",
"includeIf": [
{
"questionId": "<string>",
"value": "<string>"
}
],
"onlyIncludeIfFlagged": true,
"setResponseToField": "<string>",
"hideFromResults": true
}
],
"lastChunkUploaded": "<string>",
"numberOfChunks": 123,
"numberOfProcessedChunks": 123,
"numberOfExpectedChunks": 123,
"numberOfComments": 123,
"unreadComments": {},
"unreadTags": {},
"tags": {},
"lastLabeled": "<string>",
"bookmarkConfigsUsedDuringLabeling": [
"<string>"
],
"bookmarklabels": {},
"outcomeLabel": "CLOSED",
"manualLabels": [
{
"id": "<string>",
"bookmarkConfigId": "<string>",
"recordingId": "<string>",
"title": "<string>",
"startTimestampInMillis": 123,
"endTimestampInMillis": 123,
"exists": true,
"lastLabeledDate": "<string>",
"lastLabeledByUid": "<string>",
"unadjustedStartTimestampInMillis": 123,
"unadjustedEndTimestampInMillis": 123
}
],
"splitHistory": [
{
"splitTimestampMs": 123,
"splitRecordingId": "<string>",
"splitDate": "<string>"
}
],
"secondaryTranscriptionJobId": "<string>",
"secondaryTranscriptionService": "<string>",
"secondaryProcessingStatus": "in-progress",
"secondaryTranscriptionIgnored": true,
"secondaryTranscriptionAttempts": 123,
"secondaryTranscriptionDurationSent": 123,
"lastSuccessfulSecondaryTranscription": {
"_seconds": 123,
"_nanoseconds": 123
},
"lastSuccessfulSecondaryTranscriptionJobId": "<string>",
"leadIdSiro": "<string>",
"leadInteractionIdSiro": "<string>",
"leadInteractionMatchScore": 123,
"latitude": 123,
"longitude": 123,
"coordinates": "<unknown>",
"g": {
"geohash": "<string>",
"geopoint": "<unknown>"
},
"conversationTime": 123,
"repSpeakingTime": 123,
"customerSpeakingTime": 123,
"customerQuestionsCount": 123,
"repQuestionsCount": 123,
"exchangesCount": 123,
"repExchangesCount": 123,
"totalRepExchangesWithAQuestion": 123,
"repWordCount": 123,
"repUniqueWordsUsedCount": 123,
"repFillerWordsCount": 123,
"totalRepVocabularyScore": 123,
"totalRepWordObscurityScore": 123,
"longestMonologueMillis": 123,
"longestCustomerStoryMillis": 123,
"repWordsPerMinute": 123,
"repFillerWordsPerMin": 123,
"repSpeakerShare": 123,
"interactivityScore": 123,
"repControl": 123,
"repVocabularyLevel": 123,
"repWordObscurityScore": 123,
"conversationSegmentDates": [
{
"dateStarted": "<string>",
"dateEnded": "<string>",
"conversationType": "<string>"
}
],
"chunkStatusMap": {},
"expectedChunksOutstanding": [
"<string>"
],
"advancedBookmarksChecked": true,
"extractedPrimaryContactPhoneNumber": {
"value": "<string>",
"chunkId": "<string>",
"chunkNumber": 123,
"startTimeInMilliseconds": 123,
"endTimeInMilliseconds": 123,
"confidence": 123
},
"doNotDelete": true,
"processedChunkNumbers": [
123
],
"skippableChunkNumbers": [
123
],
"dateLackingSingleExpectedChunk": "<string>",
"audioDurationInMilliseconds": 123,
"isVideo": true,
"videoRecordingId": "<string>",
"rawVideoPath": "<string>",
"source": {
"sdkVersion": "<string>",
"bundleId": "<string>",
"appVersion": "<string>",
"appName": "<string>",
"sdkType": "iOS"
},
"transcriptionLanguage": "English",
"os": "ios",
"osVersion": "<string>",
"deviceType": "<string>",
"deviceId": "<string>",
"summaryProcessingStatus": "not-started",
"bookmarkingProcessingStatus": "not-started",
"llmBookmarkingStatus": "not-started",
"llmSpeakerAssignmentStatus": "not-started",
"conversationQualityTag": "FULL_CONVERSATION",
"conversationQualityTagReasoning": "<string>",
"llmConversationApprovalStatus": "not-started",
"aiMetricsProcessingStatus": "not-started",
"betaFeatures": [
"<string>"
],
"allChunksUploaded": true,
"recordingSettings": {
"mobileChunkCreationMode": "minimized"
},
"images": [
{
"rawImages": [
{
"type": "web",
"uri": "https://img.companycam.com/some/path/photo.jpq",
"url": "https://img.companycam.com/some/path/photo.jpq"
}
],
"linkedImage": "https://app.companycam.com/assets/Image/2176982453",
"timestamp": 1640995200000
}
],
"crmOpportunities": [
{
"opportunityExternalId": "opp_12345",
"accountId": "acc_67890",
"accountName": "Acme Corporation",
"accountExternalId": "ext_acc_12345",
"disposition": "Closed Won",
"closedAt": "2024-01-15T10:30:00Z",
"name": "Q1 Software License Renewal",
"amount": 50000,
"integrationName": "Salesforce",
"integrationPlatform": "salesforce",
"addresses": [
{
"street": "123 Main St",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
]
}
],
"crmCustomer": {
"id": "acc_12345",
"name": "Acme Corporation",
"customerType": "ACCOUNT",
"externalId": "ext_67890",
"lastActivityAt": "2024-01-15T08:30:00.000Z",
"matchingSource": "DIRECT",
"emailAddress": "[email protected]",
"phoneNumber": "+1-555-123-4567",
"crmUrl": "https://acme.salesforce.com/lightning/r/Account/001XX000004C9Z6YAK/view"
},
"mediaOpportunities": [
{
"externalId": "media_12345",
"integrationName": "HubSpot",
"integrationPlatform": "hubspot",
"name": "Social Media Campaign Lead",
"addresses": [
{
"city": "Los Angeles",
"state": "CA",
"zip": "90210",
"country": "USA"
}
],
"images": [
{
"rawImages": [
{
"type": "web",
"uri": "https://img.companycam.com/some/path/photo.jpq",
"url": "https://img.companycam.com/some/path/photo.jpq"
}
],
"linkedImage": "https://app.companycam.com/assets/Image/2176982453",
"timestamp": 1640995200000
}
]
}
],
"multimediaEvents": [
{
"storageUrl": "id1/id2",
"mimeType": "image/jpeg",
"timestampInMilliseconds": 1640995200000
},
{
"storageUrl": "id1/id2",
"mimeType": "image/jpeg",
"timestampInMilliseconds": 1640995800000
}
],
"evaluation": {
"recordingId": "<string>",
"hasScorecard": true,
"evaluatedNodes": [
{
"id": "node_001",
"name": "Conversation Quality",
"indexNumber": 1,
"parentId": "root",
"nodeType": "SECTION",
"metadata": {
"metricId": "metric_001",
"metricType": "CONVERSATION_TIME"
},
"pointsPossible": 100,
"pointsEarned": 75,
"color": "GREEN",
"description": "Metrics related to conversation quality and engagement",
"metricValue": 85,
"unit": "seconds",
"unitAbbreviated": "sec"
}
],
"metricRubrics": [
{
"scorecardNodeId": "node_001",
"scorecardMetricId": "metric_001",
"metricPointTotal": 100,
"minTarget": 0,
"maxTarget": 100,
"targetTolerance": 5
}
],
"sectionWeights": [
{
"scorecardNodeId": "node_001",
"weight": 25
}
],
"colorConfigurations": [
{
"color": "GREEN",
"lowRange": 80,
"highRange": 100
}
],
"scorecardInstanceId": "<string>",
"evaluationQualified": true,
"name": "<string>",
"description": "<string>",
"pointsPossible": 123,
"pointsEarned": 123
},
"followups": [
{
"recordingId": "<string>",
"recordingTitle": "<string>",
"repName": "<string>",
"repId": "<string>",
"teamName": "<string>",
"teamId": "<string>",
"followupId": "<string>",
"dateCreated": "<string>",
"followupType": "REHASH",
"score": 123,
"followupAction": "<string>",
"context": [
{
"header": "<string>",
"value": "<string>"
}
],
"updatedAt": "<string>",
"metadata": [
{}
],
"starred": true,
"status": "TO_DO",
"thinking": "<string>",
"crmCustomer": {
"id": "<string>",
"name": "<string>",
"crmUrl": "<string>",
"customerType": "ACCOUNT",
"lastActivityAt": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"externalId": "<string>",
"matchingSource": "DIRECT",
"opportunityId": "<string>",
"engagementId": "<string>",
"opportunity": {
"id": "<string>",
"externalId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"organizationId": "<string>",
"name": "<string>",
"amount": 123,
"closedAt": "<string>",
"disposition": "<string>",
"recordingId": "<string>",
"accountId": "<string>",
"account": "<unknown>",
"opportunityUsers": [
"<unknown>"
]
},
"contactAccount": {
"id": "<string>",
"name": "<string>",
"externalId": "<string>"
},
"address": "<string>",
"integrationConnectionId": "<string>",
"integrationPlatform": "MERGE",
"integrationName": "<string>"
},
"hasFollowupComment": true,
"note": "<string>",
"completed": true,
"completedBy": "<string>",
"completedAt": "<string>",
"history": [
{
"id": "<string>",
"updatedBy": "<string>",
"updatedByUserId": "<string>",
"createdAt": "<string>",
"note": "<string>",
"status": "TO_DO"
}
],
"crmUrl": "<string>"
}
],
"mobileEvents": [
{
"id": "event_12345",
"recordingId": "rec_123",
"userId": "user_789",
"event": {
"name": "recorderStateChange",
"value": "start",
"trigger": "interruption"
},
"organizationId": "org_456",
"dateCreated": "<unknown>",
"dateCreatedString": "2024-01-15T10:30:00Z",
"timestampInMilliseconds": 1640995200000,
"durationInMilliseconds": 5000
}
],
"seedRecordingId": "seed_rec_456",
"seedRecordingRecordingId": "seed_rec_456_rec_789"
},
"cursor": "<string>",
"pageSize": 123,
"limit": 123
}Get a recording by id
curl --request GET \
--url https://api.example.com/v1/core/recordings/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "<string>",
"dateCreated": "<string>",
"deleted": true,
"transcriptionStatus": "RECORDING",
"processingStatus": "in-progress",
"processingStage": "done",
"processingErrors": [
"bookmarking-failed",
"summary-failed"
],
"recordErrors": [
"paused-early"
],
"processingError": "<string>",
"rawAudioPath": "<string>",
"processedAudioPath": "<string>",
"lastProcessedAudio": "<string>",
"organizationId": "<string>",
"teamId": "<string>",
"userId": "<string>",
"locked": true,
"terminatedUngraciously": true,
"originalDeviceId": "<string>",
"codeVersion": "<string>",
"lock": true,
"splitLock": true,
"mergeLock": true,
"splitRetryNeeded": true,
"organizationName": "<string>",
"repFirstName": "<string>",
"repLastName": "<string>",
"speakerMap": {},
"mergeRetryNeeded": true,
"redactedTranscript": "<string>",
"confidence": 123,
"error": "<string>",
"jumpToTags": [
{
"text": "<string>",
"timestampInMilliseconds": 123,
"endTimestampInMilliseconds": 123,
"type": "<string>",
"types": [
"<string>"
],
"preview": "<string>",
"previewStartTimestampInMilliseconds": 123,
"previewChunkId": "<string>",
"bookmarkConfigId": "<string>",
"advancedBookmarkId": "<string>",
"advancedBookmarkConfirmed": true,
"repResponseId": "<string>",
"botCommentId": "<string>",
"botCommentThreadId": "<string>",
"confirmationQuestion": "<string>",
"classificationQuestions": [
{
"text": "<string>",
"result": true
}
],
"responseDetails": "<string>",
"responseJudgement": "<string>",
"exchangeStart": 123,
"exchangeEnd": 123,
"manualLabelId": "<string>",
"identifier": "<string>",
"speakerTag": "<string>",
"similarityScore": 123,
"llmConfirmed": true,
"llmJustification": "<string>",
"llmBookmarkingAnswer": "<string>"
}
],
"jumpToTagsWordsOnly": [
"<string>"
],
"lastUpdatedJumpToTags": "<string>",
"manualLabelBookmarkConfigIds": [
"<string>"
],
"result": "<string>",
"title": "<string>",
"notes": "<string>",
"durationInMilliseconds": 123,
"discoverable": true,
"isPrivate": true,
"detected_language": "<string>",
"trendingScore": 123,
"starCount": 123,
"viewCount": 123,
"uniqueViewCount": 123,
"deletedDate": "<string>",
"deletedPermanently": true,
"originalRecordingId": "<string>",
"enableAutomaticSplit": true,
"offsetFromOriginalRecordingMs": 123,
"conversationType": "<string>",
"debriefResponses": {},
"debriefQuestions": [
{
"id": "<string>",
"prompt": "<string>",
"responseType": "DATE_RESPONSE",
"responseConfig": {
"includeTime": true,
"required": true,
"latestAllowableDate": "<string>",
"earliestAllowableDate": "<string>"
},
"sortValue": 123,
"promptDetails": "<string>",
"includeIf": [
{
"questionId": "<string>",
"value": "<string>"
}
],
"onlyIncludeIfFlagged": true,
"setResponseToField": "<string>",
"hideFromResults": true
}
],
"lastChunkUploaded": "<string>",
"numberOfChunks": 123,
"numberOfProcessedChunks": 123,
"numberOfExpectedChunks": 123,
"numberOfComments": 123,
"unreadComments": {},
"unreadTags": {},
"tags": {},
"lastLabeled": "<string>",
"bookmarkConfigsUsedDuringLabeling": [
"<string>"
],
"bookmarklabels": {},
"outcomeLabel": "CLOSED",
"manualLabels": [
{
"id": "<string>",
"bookmarkConfigId": "<string>",
"recordingId": "<string>",
"title": "<string>",
"startTimestampInMillis": 123,
"endTimestampInMillis": 123,
"exists": true,
"lastLabeledDate": "<string>",
"lastLabeledByUid": "<string>",
"unadjustedStartTimestampInMillis": 123,
"unadjustedEndTimestampInMillis": 123
}
],
"splitHistory": [
{
"splitTimestampMs": 123,
"splitRecordingId": "<string>",
"splitDate": "<string>"
}
],
"secondaryTranscriptionJobId": "<string>",
"secondaryTranscriptionService": "<string>",
"secondaryProcessingStatus": "in-progress",
"secondaryTranscriptionIgnored": true,
"secondaryTranscriptionAttempts": 123,
"secondaryTranscriptionDurationSent": 123,
"lastSuccessfulSecondaryTranscription": {
"_seconds": 123,
"_nanoseconds": 123
},
"lastSuccessfulSecondaryTranscriptionJobId": "<string>",
"leadIdSiro": "<string>",
"leadInteractionIdSiro": "<string>",
"leadInteractionMatchScore": 123,
"latitude": 123,
"longitude": 123,
"coordinates": "<unknown>",
"g": {
"geohash": "<string>",
"geopoint": "<unknown>"
},
"conversationTime": 123,
"repSpeakingTime": 123,
"customerSpeakingTime": 123,
"customerQuestionsCount": 123,
"repQuestionsCount": 123,
"exchangesCount": 123,
"repExchangesCount": 123,
"totalRepExchangesWithAQuestion": 123,
"repWordCount": 123,
"repUniqueWordsUsedCount": 123,
"repFillerWordsCount": 123,
"totalRepVocabularyScore": 123,
"totalRepWordObscurityScore": 123,
"longestMonologueMillis": 123,
"longestCustomerStoryMillis": 123,
"repWordsPerMinute": 123,
"repFillerWordsPerMin": 123,
"repSpeakerShare": 123,
"interactivityScore": 123,
"repControl": 123,
"repVocabularyLevel": 123,
"repWordObscurityScore": 123,
"conversationSegmentDates": [
{
"dateStarted": "<string>",
"dateEnded": "<string>",
"conversationType": "<string>"
}
],
"chunkStatusMap": {},
"expectedChunksOutstanding": [
"<string>"
],
"advancedBookmarksChecked": true,
"extractedPrimaryContactPhoneNumber": {
"value": "<string>",
"chunkId": "<string>",
"chunkNumber": 123,
"startTimeInMilliseconds": 123,
"endTimeInMilliseconds": 123,
"confidence": 123
},
"doNotDelete": true,
"processedChunkNumbers": [
123
],
"skippableChunkNumbers": [
123
],
"dateLackingSingleExpectedChunk": "<string>",
"audioDurationInMilliseconds": 123,
"isVideo": true,
"videoRecordingId": "<string>",
"rawVideoPath": "<string>",
"source": {
"sdkVersion": "<string>",
"bundleId": "<string>",
"appVersion": "<string>",
"appName": "<string>",
"sdkType": "iOS"
},
"transcriptionLanguage": "English",
"os": "ios",
"osVersion": "<string>",
"deviceType": "<string>",
"deviceId": "<string>",
"summaryProcessingStatus": "not-started",
"bookmarkingProcessingStatus": "not-started",
"llmBookmarkingStatus": "not-started",
"llmSpeakerAssignmentStatus": "not-started",
"conversationQualityTag": "FULL_CONVERSATION",
"conversationQualityTagReasoning": "<string>",
"llmConversationApprovalStatus": "not-started",
"aiMetricsProcessingStatus": "not-started",
"betaFeatures": [
"<string>"
],
"allChunksUploaded": true,
"recordingSettings": {
"mobileChunkCreationMode": "minimized"
},
"images": [
{
"rawImages": [
{
"type": "web",
"uri": "https://img.companycam.com/some/path/photo.jpq",
"url": "https://img.companycam.com/some/path/photo.jpq"
}
],
"linkedImage": "https://app.companycam.com/assets/Image/2176982453",
"timestamp": 1640995200000
}
],
"crmOpportunities": [
{
"opportunityExternalId": "opp_12345",
"accountId": "acc_67890",
"accountName": "Acme Corporation",
"accountExternalId": "ext_acc_12345",
"disposition": "Closed Won",
"closedAt": "2024-01-15T10:30:00Z",
"name": "Q1 Software License Renewal",
"amount": 50000,
"integrationName": "Salesforce",
"integrationPlatform": "salesforce",
"addresses": [
{
"street": "123 Main St",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
]
}
],
"crmCustomer": {
"id": "acc_12345",
"name": "Acme Corporation",
"customerType": "ACCOUNT",
"externalId": "ext_67890",
"lastActivityAt": "2024-01-15T08:30:00.000Z",
"matchingSource": "DIRECT",
"emailAddress": "[email protected]",
"phoneNumber": "+1-555-123-4567",
"crmUrl": "https://acme.salesforce.com/lightning/r/Account/001XX000004C9Z6YAK/view"
},
"mediaOpportunities": [
{
"externalId": "media_12345",
"integrationName": "HubSpot",
"integrationPlatform": "hubspot",
"name": "Social Media Campaign Lead",
"addresses": [
{
"city": "Los Angeles",
"state": "CA",
"zip": "90210",
"country": "USA"
}
],
"images": [
{
"rawImages": [
{
"type": "web",
"uri": "https://img.companycam.com/some/path/photo.jpq",
"url": "https://img.companycam.com/some/path/photo.jpq"
}
],
"linkedImage": "https://app.companycam.com/assets/Image/2176982453",
"timestamp": 1640995200000
}
]
}
],
"multimediaEvents": [
{
"storageUrl": "id1/id2",
"mimeType": "image/jpeg",
"timestampInMilliseconds": 1640995200000
},
{
"storageUrl": "id1/id2",
"mimeType": "image/jpeg",
"timestampInMilliseconds": 1640995800000
}
],
"evaluation": {
"recordingId": "<string>",
"hasScorecard": true,
"evaluatedNodes": [
{
"id": "node_001",
"name": "Conversation Quality",
"indexNumber": 1,
"parentId": "root",
"nodeType": "SECTION",
"metadata": {
"metricId": "metric_001",
"metricType": "CONVERSATION_TIME"
},
"pointsPossible": 100,
"pointsEarned": 75,
"color": "GREEN",
"description": "Metrics related to conversation quality and engagement",
"metricValue": 85,
"unit": "seconds",
"unitAbbreviated": "sec"
}
],
"metricRubrics": [
{
"scorecardNodeId": "node_001",
"scorecardMetricId": "metric_001",
"metricPointTotal": 100,
"minTarget": 0,
"maxTarget": 100,
"targetTolerance": 5
}
],
"sectionWeights": [
{
"scorecardNodeId": "node_001",
"weight": 25
}
],
"colorConfigurations": [
{
"color": "GREEN",
"lowRange": 80,
"highRange": 100
}
],
"scorecardInstanceId": "<string>",
"evaluationQualified": true,
"name": "<string>",
"description": "<string>",
"pointsPossible": 123,
"pointsEarned": 123
},
"followups": [
{
"recordingId": "<string>",
"recordingTitle": "<string>",
"repName": "<string>",
"repId": "<string>",
"teamName": "<string>",
"teamId": "<string>",
"followupId": "<string>",
"dateCreated": "<string>",
"followupType": "REHASH",
"score": 123,
"followupAction": "<string>",
"context": [
{
"header": "<string>",
"value": "<string>"
}
],
"updatedAt": "<string>",
"metadata": [
{}
],
"starred": true,
"status": "TO_DO",
"thinking": "<string>",
"crmCustomer": {
"id": "<string>",
"name": "<string>",
"crmUrl": "<string>",
"customerType": "ACCOUNT",
"lastActivityAt": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"externalId": "<string>",
"matchingSource": "DIRECT",
"opportunityId": "<string>",
"engagementId": "<string>",
"opportunity": {
"id": "<string>",
"externalId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"organizationId": "<string>",
"name": "<string>",
"amount": 123,
"closedAt": "<string>",
"disposition": "<string>",
"recordingId": "<string>",
"accountId": "<string>",
"account": "<unknown>",
"opportunityUsers": [
"<unknown>"
]
},
"contactAccount": {
"id": "<string>",
"name": "<string>",
"externalId": "<string>"
},
"address": "<string>",
"integrationConnectionId": "<string>",
"integrationPlatform": "MERGE",
"integrationName": "<string>"
},
"hasFollowupComment": true,
"note": "<string>",
"completed": true,
"completedBy": "<string>",
"completedAt": "<string>",
"history": [
{
"id": "<string>",
"updatedBy": "<string>",
"updatedByUserId": "<string>",
"createdAt": "<string>",
"note": "<string>",
"status": "TO_DO"
}
],
"crmUrl": "<string>"
}
],
"mobileEvents": [
{
"id": "event_12345",
"recordingId": "rec_123",
"userId": "user_789",
"event": {
"name": "recorderStateChange",
"value": "start",
"trigger": "interruption"
},
"organizationId": "org_456",
"dateCreated": "<unknown>",
"dateCreatedString": "2024-01-15T10:30:00Z",
"timestampInMilliseconds": 1640995200000,
"durationInMilliseconds": 5000
}
],
"seedRecordingId": "seed_rec_456",
"seedRecordingRecordingId": "seed_rec_456_rec_789"
},
"cursor": "<string>",
"pageSize": 123,
"limit": 123
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
ID of the recording to fetch
Include photos in the response (true/false)
Include CRM opportunities in the response (true/false)
Include media opportunities in the response (true/false)
Include evaluation data in the response (true/false)
Include multimedia events in the response (true/false)
Include mobile events in the response (true/false)
Include followups in the response (true/false)
Include crm accounts in the response (true/false)
Get recording by ID
Show child attributes
Unique identifier for the recording.
When the recording was created.
Indicates if the recording is deleted.
Current transcription status of the recording.
RECORDING, UPLOADING, UPLOADED, TRANSCRIBING, AWAITING_REDACTION, REDACTING, COMPLETE, SECONDARY_TRANSCRIPTION_COMPLETE, ERROR, UNRECOVERABLE_ERROR, REMOVED, RAW_SPLIT Overall processing status.
in-progress, complete, error Current stage in the recording processing pipeline (recording, uploading, processing, done)
recording, uploading, processing, done "done"
List of errors encountered during recording processing
bookmarking-failed, summary-failed ["bookmarking-failed", "summary-failed"]Errors specific to mobile recording.
paused-early, interrupted, stopped-early General processing error message.
Path to the raw audio file.
Path to the processed audio file.
Timestamp of the last audio processing.
ID of the organization associated with the recording.
ID of the team associated with the recording.
ID of the user who created the recording.
Indicates if the recording is locked.
Indicates if the recording was terminated unexpectedly.
Device ID that created the recording.
App version/build/code that created the recording.
General lock for the recording.
Indicates if a split is in progress.
Indicates if a merge is in progress.
Indicates if a split retry is needed.
Name of the organization.
First name of the representative.
Last name of the representative.
Indicates if a merge retry is needed.
Redacted transcript text.
Confidence score for the recording.
General error message.
Array of jump-to tags/bookmarks.
Show child attributes
Array of tag texts only.
Timestamp of last jump-to-tags update.
Bookmark config IDs used for manual labeling.
Result of the recording (e.g., closed, not closed).
Title of the recording.
Notes about the recording.
Duration of the recording in milliseconds.
Whether the recording is discoverable.
Whether the recording is private.
Detected language of the recording.
Trending score for the recording.
Number of stars/bookmarks.
Total view count.
Unique view count.
Date when the recording was deleted.
Indicates if the recording was permanently deleted.
ID of the original recording (if split).
Whether automatic split is enabled.
Offset from the original recording in ms.
Type of conversation.
Array of debrief questions.
Show child attributes
DATE_RESPONSE, FREE_TEXT_RESPONSE, SELECT_RESPONSE Timestamp of the last chunk uploaded.
Number of chunks in the recording.
Number of processed chunks.
Number of expected chunks.
Number of comments.
Timestamp of last manual label.
Bookmark configs used during labeling.
Outcome label (deprecated).
CLOSED, NOT_CLOSED Array of manual labels.
Show child attributes
ID of the secondary transcription job.
Service used for secondary transcription.
Processing status of secondary transcription.
in-progress, complete, error Whether secondary transcription was ignored.
Number of secondary transcription attempts.
Milliseconds of audio sent to secondary transcription.
ID of last successful secondary transcription job.
Lead ID in Siro.
Lead interaction ID in Siro.
Lead interaction match score.
Latitude of the recording location.
Longitude of the recording location.
Firestore geopoint type.
Milliseconds spent actively in conversation.
Milliseconds the rep spoke.
Milliseconds the customer spoke.
Number of questions asked by the customer.
Number of questions asked by the rep.
Total number of speaking turns.
Number of speaking turns by the rep.
Total rep exchanges with a question.
Total words spoken by the rep.
Unique words used by the rep.
Filler words used by the rep.
Total vocabulary score for the rep.
Total word obscurity score for the rep.
Longest uninterrupted rep monologue in ms.
Longest uninterrupted customer story in ms.
Rep words per minute.
Rep filler words per minute.
Rep speaker share as percent.
Interactivity score.
Percent of rep exchanges that include a question.
Rep vocabulary level (CEFR).
Rep word obscurity score.
IDs of chunks not yet uploaded.
Whether advanced bookmarks have been checked.
Extracted primary contact phone number.
Show child attributes
Whether the recording is protected from deletion.
Array of processed chunk numbers.
Array of skippable chunk numbers.
Date when a single chunk was missing.
Audio duration in milliseconds.
Whether the recording is a video.
ID of the associated video recording.
Path to the raw video file.
Language used for transcription.
English, Spanish, French Operating system of the device.
ios, android, windows, macos, web OS version of the device.
Type of device used.
Device ID.
Summary processing status.
not-started Bookmarking processing status.
not-started LLM bookmarking status.
not-started LLM speaker assignment status.
not-started Conversation quality tag.
FULL_CONVERSATION, NOT_FULL_CONVERSATION Reasoning for conversation quality tag.
LLM conversation approval status.
not-started AI metrics processing status.
not-started Enabled beta features.
Whether all chunks have been uploaded.
Array of image groups captured during the recording session
Show child attributes
Array of raw images captured during the recording
Show child attributes
Type of image (e.g., screenshot, photo)
"screenshot"
Public URI reference to the image
"https://img.companycam.com/some/path/photo.jpq"
Public URL for accessing the image
"https://app.companycam.com/assets/Image/2176982453"
[
{
"type": "web",
"uri": "https://img.companycam.com/some/path/photo.jpq",
"url": "https://img.companycam.com/some/path/photo.jpq"
},
{
"type": "thumbnail",
"uri": "https://img.companycam.com/some/path/photo.jpq",
"url": "https://img.companycam.com/some/path/photo.jpq"
}
]Primary linked image URL for the recording
"https://app.companycam.com/assets/Image/2176982453"
Timestamp when the image group was captured (milliseconds since epoch)
1640995200000
[
{
"rawImages": [
{
"type": "web",
"uri": "https://img.companycam.com/some/path/photo.jpq",
"url": "https://img.companycam.com/some/path/photo.jpq"
}
],
"linkedImage": "https://app.companycam.com/assets/Image/2176982453",
"timestamp": 1640995200000
}
]Array of CRM opportunities linked to this recording
Show child attributes
External ID of the opportunity from the CRM system
"opp_12345"
Internal account ID
"acc_67890"
Name of the account or company
"Acme Corporation"
External account ID from the CRM system
"ext_acc_12345"
Current disposition or status of the opportunity
"Closed Won"
Date when the opportunity was closed (ISO string)
"2024-01-15T10:30:00Z"
Name of the opportunity
"Q1 Software License Renewal"
Monetary amount of the opportunity
50000
Name of the CRM integration
"Salesforce"
Platform of the CRM integration
"salesforce"
Array of addresses associated with the opportunity
Show child attributes
Street address
"123 Main St"
City name
"New York"
State or province
"NY"
ZIP or postal code
"10001"
Country name
"USA"
[
{
"street": "123 Main St",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
][
{
"opportunityExternalId": "opp_12345",
"accountId": "acc_67890",
"accountName": "Acme Corporation",
"accountExternalId": "ext_acc_12345",
"disposition": "Closed Won",
"closedAt": "2024-01-15T10:30:00Z",
"name": "Q1 Software License Renewal",
"amount": 50000,
"integrationName": "Salesforce",
"integrationPlatform": "salesforce",
"addresses": [
{
"street": "123 Main St",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
]
}
]CRM account linked to this recording
Show child attributes
Customer ID
Customer name
URL to this customer in the linked CRM
ACCOUNT, LEAD, OPPORTUNITY, ENGAGEMENT, CONTACT Last activity date
Customer email addresses
Customer phone numbers
Customer external ID
Source of matching
DIRECT, FUZZY, NOT_FOUND Opportunity ID
Engagement ID
Opportunity
Show child attributes
The ID of the opportunity in the external system (e.g. Salesforce)
The date the opportunity was created
The date the opportunity was last updated
The name of the opportunity
The dollar amount of the opportunity
The closure date of the opportunity
"WON" | "LOST" | "OPEN"
The ID of the recording associated to the opportunity
Address
Integration Connection ID
Integration Platform
MERGE, SIRO_CUSTOM_INPUT, SERVICE_TITAN, COMPANY_CAM, INGAGE, LEAD_PERFECTION, SPOTIO Integration Name
{
"id": "acc_12345",
"name": "Acme Corporation",
"customerType": "ACCOUNT",
"externalId": "ext_67890",
"lastActivityAt": "2024-01-15T08:30:00.000Z",
"matchingSource": "DIRECT",
"emailAddress": "[email protected]",
"phoneNumber": "+1-555-123-4567",
"crmUrl": "https://acme.salesforce.com/lightning/r/Account/001XX000004C9Z6YAK/view"
}Array of media opportunities linked to this recording
Show child attributes
External ID from the media platform
"media_12345"
Name of the media integration
"HubSpot"
Platform of the media integration
"hubspot"
Array of addresses associated with the media opportunity
Show child attributes
Street address
"123 Main St"
City name
"New York"
State or province
"NY"
ZIP or postal code
"10001"
Country name
"USA"
[
{
"city": "Los Angeles",
"state": "CA",
"zip": "90210",
"country": "USA"
}
]Name of the media opportunity
"Social Media Campaign Lead"
Array of images associated with the media opportunity
Show child attributes
Array of raw images captured during the recording
Show child attributes
Type of image (e.g., screenshot, photo)
"screenshot"
Public URI reference to the image
"https://img.companycam.com/some/path/photo.jpq"
Public URL for accessing the image
"https://app.companycam.com/assets/Image/2176982453"
[
{
"type": "web",
"uri": "https://img.companycam.com/some/path/photo.jpq",
"url": "https://img.companycam.com/some/path/photo.jpq"
},
{
"type": "thumbnail",
"uri": "https://img.companycam.com/some/path/photo.jpq",
"url": "https://img.companycam.com/some/path/photo.jpq"
}
]Primary linked image URL for the recording
"https://app.companycam.com/assets/Image/2176982453"
Timestamp when the image group was captured (milliseconds since epoch)
1640995200000
[
{
"rawImages": [
{
"type": "web",
"uri": "https://img.companycam.com/some/path/photo.jpq",
"url": "https://img.companycam.com/some/path/photo.jpq"
}
],
"linkedImage": "https://app.companycam.com/assets/Image/2176982453",
"timestamp": 1640995200000
}
][
{
"externalId": "media_12345",
"integrationName": "HubSpot",
"integrationPlatform": "hubspot",
"name": "Social Media Campaign Lead",
"addresses": [
{
"city": "Los Angeles",
"state": "CA",
"zip": "90210",
"country": "USA"
}
],
"images": [
{
"rawImages": [
{
"type": "web",
"uri": "https://img.companycam.com/some/path/photo.jpq",
"url": "https://img.companycam.com/some/path/photo.jpq"
}
],
"linkedImage": "https://app.companycam.com/assets/Image/2176982453",
"timestamp": 1640995200000
}
]
}
]Array of multimedia events (videos, audio clips) captured during the recording
Show child attributes
URL where the multimedia file is stored
"id1/id2"
MIME type of the multimedia file
"image/jpeg"
Timestamp when the multimedia event occurred (milliseconds since epoch)
1640995200000
[
{
"storageUrl": "id1/id2",
"mimeType": "image/jpeg",
"timestampInMilliseconds": 1640995200000
},
{
"storageUrl": "id1/id2",
"mimeType": "image/jpeg",
"timestampInMilliseconds": 1640995800000
}
]AI-powered evaluation and scoring data for the recording
Show child attributes
Show child attributes
Unique identifier for the node
"node_001"
Display name for the node
"Conversation Quality"
Order of this node within its parent
1
ID of the parent node (empty string for root)
"root"
Type of node (METRIC, SECTION, or ROOT)
METRIC, SECTION, ROOT "SECTION"
Metadata specific to the node type
Show child attributes
ID of the metric configuration this node represents
"metric_001"
The type of metric this node represents
RECORDING_COUNT, BOOKMARK, CONVERSATION_TIME, REP_SPEAKING_TIME, CUSTOMER_SPEAKING_TIME, CUSTOMER_QUESTIONS_COUNT, REP_QUESTIONS_COUNT, EXCHANGES_COUNT, REP_EXCHANGES_COUNT, TOTAL_REP_EXCHANGES_WITH_A_QUESTION, REP_WORD_COUNT, REP_UNIQUE_WORDS_USED_COUNT, REP_FILLER_WORDS_COUNT, TOTAL_REP_VOCABULARY_SCORE, TOTAL_REP_WORD_OBSCURITY_SCORE, LONGEST_MONOLOGUE_SECONDS, LONGEST_CUSTOMER_STORY_SECONDS, REP_WORDS_PER_MINUTE, REP_FILLER_WORDS_PER_MIN, REP_SPEAKER_SHARE, INTERACTIVITY_SCORE, REP_CONTROL, REP_VOCABULARY_LEVEL, REP_WORD_OBSCURITY_SCORE, AI_METRIC "CONVERSATION_TIME"
Maximum points possible for this node
100
Points earned based on the metric value
75
Color indicating performance level (RED, YELLOW, GREEN)
GREEN, YELLOW, RED "GREEN"
Optional description of the node
"Metrics related to conversation quality and engagement"
The calculated value for this metric
85
Full unit name for the metric value
"seconds"
Abbreviated unit name for the metric value
"sec"
Show child attributes
ID of the scorecard node this rubric applies to
"node_001"
ID of the metric this rubric evaluates
"metric_001"
Maximum points possible for this metric
100
Minimum target value for this metric
0
Maximum target value for this metric
100
Tolerance range around the target values
5
Show child attributes
Color indicating performance level
GREEN, YELLOW, RED "GREEN"
Lower bound of the range for this color
80
Upper bound of the range for this color
100
Array of follow-up actions and communications generated from the recording
Show child attributes
Followup recording id
Followup recording title
Followup rep name
Followup rep id
Followup team name
Followup team id
Followup id
Followup date created. ISO 8601 UTC timestamp.
Followup type. Can be REHASH or CROSS_SELL.
REHASH, CROSS_SELL Followup score. Can be between 1 and 5.
Followup action
Followup context
Show child attributes
Followup context header. Can be MAIN_OBJECTION, EMOTIONAL_TIE, OVERALL_COST, SCOPE, FOLLOW_UP_TIME, SECONDARY_OBJECTION, SCOPE_COST_SUMMARY, OBJECTION_SUMMARY, FOLLOW_UP_SUMMARY, FIRST_PRICE_QUOTE, FINAL_PRICE_QUOTE, PRICING_OPTIONS, FINANCING, COMMITMENT.
Followup context value
Followup updated at. ISO 8601 UTC timestamp.
Followup starred state. Can be true or false.
Followup status. Can be TO_DO, IN_PROGRESS, or COMPLETE.
TO_DO, IN_PROGRESS, COMPLETE Followup thinking and score breakdown
Followup CRM customer. Includes the CRM customer if the followup is associated with a CRM customer.
Show child attributes
Customer ID
Customer name
URL to this customer in the linked CRM
ACCOUNT, LEAD, OPPORTUNITY, ENGAGEMENT, CONTACT Last activity date
Customer email addresses
Customer phone numbers
Customer external ID
Source of matching
DIRECT, FUZZY, NOT_FOUND Opportunity ID
Engagement ID
Opportunity
Show child attributes
The ID of the opportunity in the external system (e.g. Salesforce)
The date the opportunity was created
The date the opportunity was last updated
The name of the opportunity
The dollar amount of the opportunity
The closure date of the opportunity
"WON" | "LOST" | "OPEN"
The ID of the recording associated to the opportunity
Contact Account
Address
Integration Connection ID
Integration Platform
MERGE, SIRO_CUSTOM_INPUT, SERVICE_TITAN, COMPANY_CAM, INGAGE, LEAD_PERFECTION, SPOTIO Integration Name
Whether the followup has a followup specific comment on the associated recording.
Followup note. Deprecated in favor of FollowupHistory.
Followup completed state. Deprecated in favor of status, which is included in FollowupHistory.
Followup completed by. Deprecated in favor of FollowupHistory.
Followup completed at. ISO 8601 UTC timestamp. Deprecated in favor of FollowupHistory.
Followup history. Returns all status changes and notes for the followup.
Show child attributes
Followup history id
Followup history updated by
Followup history updated by user id. Null if the updated by is a Siro system action.
Followup history created at. ISO 8601 UTC timestamp.
Followup history note
Followup history status
TO_DO, IN_PROGRESS, COMPLETE URL to the customer in the linked CRM (DEPRECATED)
Array of mobile app events that occurred during the recording session
Show child attributes
Unique identifier for the mobile event
"event_12345"
ID of the recording this event belongs to
"rec_123"
ID of the user who triggered the event
"user_789"
Core recording event data
Show child attributes
recorderStateChange start, resume, pause, stop, cancelled interruption, buttonPress, deeplink, maxRecordingTimeExceeded, unknown ID of the organization
"org_456"
Not used
Date when the event was created, ISO 8601 format.
"2024-01-15T10:30:00Z"
Timestamp when the event occurred (milliseconds since epoch)
1640995200000
Duration of the event in milliseconds
5000
ID of the seed recording that this recording is based on
"seed_rec_456"
ID of the recording within the seed recording collection
"seed_rec_456_rec_789"