Call data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for this call object |
created_at | string (date-time) | No | The date that this call object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | The last date that this call object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
contact_id | string | No | The contact ID for call (reference to UcContact) |
telephone | object | No | The telephone number called |
telephone.telephone | string | No | |
telephone.type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE |
start_at | string (date-time) | No | The start time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | The end time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
user_id | string | No | (reference to HrisEmployee) |
contacts | UcContact[] | No | |
contacts[].id | string | No | Unique identifier for this contact object |
contacts[].created_at | string (date-time) | No | The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
contacts[].updated_at | string (date-time) | No | The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
contacts[].name | string | No | The name of the contact |
contacts[].first_name | string | No | |
contacts[].last_name | string | No | |
contacts[].title | string | No | The job title of the contact |
contacts[].company | string | No | The company/organization name of the contact |
contacts[].emails | UcEmail[] | No | An array of email addresses for this contact |
contacts[].emails[].email | string | Yes | |
contacts[].emails[].type | enum | No | Values: WORK, HOME, OTHER |
contacts[].telephones | UcTelephone[] | No | An array of telephones for this contact |
contacts[].telephones[].telephone | string | Yes | |
contacts[].telephones[].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE |
is_private | boolean | No | |
user_name | string | No | |
user_phone | string | No | |
type | enum | No | Values: INBOUND, OUTBOUND |
metadata | UcMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
conversation_identifier | string | No | opaque identifier shared across legs of one interaction |
Are we missing anything? Let us know