Call data model

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

FieldTypeRequiredDescription
idstringNoUnique identifier for this call object
created_atstring (date-time)NoThe date that this call object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this call object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
contact_idstringNoThe contact ID for call (reference to UcContact)
telephoneobjectNoThe telephone number called
telephone.telephonestringNo
telephone.typeenumNoValues: WORK, HOME, OTHER, FAX, MOBILE
start_atstring (date-time)NoThe start time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)NoThe end time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
user_idstringNo(reference to HrisEmployee)
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
is_privatebooleanNo
user_namestringNo
user_phonestringNo
typeenumNoValues: INBOUND, OUTBOUND
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
conversation_identifierstringNoopaque identifier shared across legs of one interaction

TypeScript

TypeScript
export type UcCall = {
	id?: string; // Unique identifier for this call object
	created_at?: string-time; // The date that this call object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // The last date that this call object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	contact_id?: string; // The contact ID for call (reference to UcContact)
	telephone?: {
		telephone?: string; 
		type?: 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE'; 
	}; // The telephone number called
	start_at?: string-time; // The start time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // The end time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	user_id?: string; // (reference to HrisEmployee)
	contacts?: [];
	is_private?: boolean;
	user_name?: string;
	user_phone?: string;
	type?: 'INBOUND' | 'OUTBOUND';
	metadata?: [];
	raw?: any; // The raw data returned by the integration for this call
	conversation_identifier?: string; // opaque identifier shared across legs of one interaction
} 

Zod

Zod
import { z } from 'zod';

export const ZodUcCall = z.object({
	id: z.string().optional().describe("Unique identifier for this call object"),
	created_at: z.string-time().optional().describe("The date that this call object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("The last date that this call object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	contact_id: z.string().optional().describe("The contact ID for call (reference to UcContact)"),
	telephone: z.object({
			telephone: z.string().optional(),
			type: z.enum("WORK", "HOME", "OTHER", "FAX", "MOBILE").optional()
}).optional().describe("The telephone number called"),
	start_at: z.string-time().optional().describe("The start time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("The end time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	user_id: z.string().optional().describe("(reference to HrisEmployee)"),
	contacts: z.array().optional(),
	is_private: z.boolean().optional(),
	user_name: z.string().optional(),
	user_phone: z.string().optional(),
	type: z.enum("INBOUND", "OUTBOUND").optional(),
	metadata: z.array().optional(),
,
	conversation_identifier: z.string().optional().describe("opaque identifier shared across legs of one interaction")
});

Python

Python
import dataclasses

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

@dataclasses.dataclass
class UcCallTelephoneType(str, Enum):
	WORK = 'WORK'
	HOME = 'HOME'
	OTHER = 'OTHER'
	FAX = 'FAX'
	MOBILE = 'MOBILE'

@dataclasses.dataclass
class PropertyUcCallTelephone:
	telephone: Optional[str]
	type: Optional[UcCallTelephoneType]

@dataclasses.dataclass
class UcCall:
	"""Unique identifier for this call object"""
	id: Optional[str]
	"""The date that this call object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The last date that this call object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The contact ID for call (reference to UcContact)"""
	contact_id: Optional[str]
	"""The telephone number called"""
	telephone: Optional[PropertyUcCallTelephone]
	"""The start time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""The end time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	"""(reference to HrisEmployee)"""
	user_id: Optional[str]
	contacts: Optional[PropertyUcCallContacts]
	is_private: Optional[bool]
	user_name: Optional[str]
	user_phone: Optional[str]
	type: Optional[UcCallType]
	metadata: Optional[PropertyUcCallMetadata]

	"""opaque identifier shared across legs of one interaction"""
	conversation_identifier: Optional[str]
Are we missing anything? Let us know
Was this page helpful?