Key Concepts

The LiveSwitch API works with a small set of resources.

Resource	What it is
Conversation	One interaction with a customer: a live call, a recording request, a photo request, an upload, or a scheduled call. The LiveSwitch app calls it a Session.
Project	A group of Conversations for one job, claim, or installation. A Project is optional.
Contact	The person that a Conversation is with. If you create a Conversation with a phone number, LiveSwitch finds or creates the Contact.
Recordings, photos, documents	The media in a Conversation or a Project.
Spark	An AI report (Sparky) that runs on a Conversation or a Project.
Tags	Simple labels on Conversations and Projects.
Attributes	Custom fields with a type (text, number, date, link, and more) on Conversations and Projects.

How they connect

Project (optional)
 ├─ Conversation
 │   ├─ Contact
 │   ├─ Recordings, photos, documents
 │   ├─ Tags and attributes
 │   └─ Sparks
 ├─ Contacts
 ├─ Recordings, photos, documents
 ├─ Tags and attributes
 └─ Sparks

A Conversation does not need a Project. Use a Project when one job has more than one Conversation and you want all its media in one place.

Conversations and Projects each have:

A status.
A URL for users who log in, and an embedded version of that URL.

A Project also has a public share URL that does not need a login. A Conversation does not have its own share URL.

Where to go next

Authentication: get an access token.
Creating a Conversation
Working with Projects
List, filter, and sort
Webhooks: get a notification when a Conversation, Contact, recording, or document changes.
Sparky AI Reports