Recording data model

Updated:

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
expires_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
call_idstringNo
web_urlstringNo
contactsUcContact[]No
contacts[].idstringNoUnique identifier for this contact object
contacts[].created_atstring (date-time)NoThe date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
contacts[].updated_atstring (date-time)NoThe last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
contacts[].namestringNoThe name of the contact
contacts[].first_namestringNo
contacts[].last_namestringNo
contacts[].titlestringNoThe job title of the contact
contacts[].companystringNoThe company/organization name of the contact
contacts[].emailsUcEmail[]NoAn array of email addresses for this contact
contacts[].emails[].emailstringYes
contacts[].emails[].typeenumNoValues: WORK, HOME, OTHER
contacts[].telephonesUcTelephone[]NoAn array of telephones for this contact
contacts[].telephones[].telephonestringYes
contacts[].telephones[].typeenumNoValues: WORK, HOME, OTHER, FAX, MOBILE
contacts[].metadataUcMetadata[]No
contacts[].metadata[].idstringNo
contacts[].metadata[].slugstringNo
contacts[].metadata[].valueobjectNo
contacts[].metadata[].namespacestringNo
contacts[].metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
contacts[].metadata[].extra_dataobjectNo
user_idstringNoreference to HrisEmployee (reference to HrisEmployee)
mediaUcRecordingMedia[]No
media[].start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
media[].end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
media[].languagestringNotwo digit ISO code
media[].transcriptsUcRecordingTranscript[]No
media[].transcripts[].start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
media[].transcripts[].end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
media[].transcripts[].textstringYes
media[].transcripts[].contact_idstringNo(reference to UcContact)
media[].transcripts[].user_idstringNoreference to HrisEmployee (reference to HrisEmployee)
media[].transcript_download_urlstringNo
media[].recording_download_urlstringNo
user_namestringNo
user_phonestringNo
typeenumNoValues: INBOUND, OUTBOUND
conversation_identifierstringNoopaque identifier shared across legs of one interaction
metadataUcMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

TypeScript

TypeScript
export type UcRecording = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	start_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	expires_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	call_id?: string;
	web_url?: string;
	contacts?: [];
	user_id?: string; // reference to HrisEmployee (reference to HrisEmployee)
	media?: [];
	user_name?: string;
	user_phone?: string;
	type?: 'INBOUND' | 'OUTBOUND';
	conversation_identifier?: string; // opaque identifier shared across legs of one interaction
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodUcRecording = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	start_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	expires_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	call_id: z.string().optional(),
	web_url: z.string().optional(),
	contacts: z.array().optional(),
	user_id: z.string().optional().describe("reference to HrisEmployee (reference to HrisEmployee)"),
	media: z.array().optional(),
	user_name: z.string().optional(),
	user_phone: z.string().optional(),
	type: z.enum("INBOUND", "OUTBOUND").optional(),
	conversation_identifier: z.string().optional().describe("opaque identifier shared across legs of one interaction"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class UcRecordingType(str, Enum):
	INBOUND = 'INBOUND'
	OUTBOUND = 'OUTBOUND'

@dataclasses.dataclass
class UcRecording:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	expires_at: Optional[str]
	call_id: Optional[str]
	web_url: Optional[str]
	contacts: Optional[PropertyUcRecordingContacts]
	"""reference to HrisEmployee (reference to HrisEmployee)"""
	user_id: Optional[str]
	media: Optional[PropertyUcRecordingMedia]
	user_name: Optional[str]
	user_phone: Optional[str]
	type: Optional[UcRecordingType]
	"""opaque identifier shared across legs of one interaction"""
	conversation_identifier: Optional[str]
	metadata: Optional[PropertyUcRecordingMetadata]
Are we missing anything? Let us know
Was this page helpful?