Documentation
Service VIN developer & AI platformGetting startedAuthenticationPaginationIdempotencyRate limitsErrorsWebhooks & signature verificationConnecting ClaudeRecipesMCP servers & the Claude connectorREST resource referenceCapability indexCustomers capabilitiesVehicles capabilitiesLeads capabilitiesWarranties capabilitiesQuotes capabilitiesInvoices capabilitiesPayments capabilitiesServices capabilitiesJobs capabilitiesCalendar capabilitiesScheduling capabilitiesStaff capabilitiesInventory capabilitiesComms capabilitiesTasks capabilitiesShop capabilitiesDocuments capabilitiesKnowledge capabilitiesReports capabilitiesBooking capabilitiesForms capabilitiesMarketing capabilitiesReviews capabilitiesAutomations capabilitiesIntegrations capabilitiesChangelogSearch
Domain
Comms capabilities
21 capabilities, all acting on a message. A reference to one from another domain is spelled
message_id — never a bare id — and every one of those fields names the capability that produces it, so a model can chain calls without guessing.| Capability | What it does | Effect |
|---|---|---|
| comms.list_callsPOST /api/v1/comms/list_calls | List calls by date, direction or outcome, with any voicemail message | read-only |
| comms.get_callPOST /api/v1/comms/get_call | Get one call — direction, outcome, duration and voicemail message | read-only |
| comms.list_missed_callsPOST /api/v1/comms/list_missed_calls | List missed calls and any voicemail message the caller left | read-only |
| comms.get_call_recordingPOST /api/v1/comms/get_call_recording | Get a short-lived signed link to a call recording or voicemail message | read-only |
| comms.get_call_transcriptPOST /api/v1/comms/get_call_transcript | Read what was said on a call, word for word — speech, not a message | read-only |
| comms.get_call_analysisPOST /api/v1/comms/get_call_analysis | Read a call's AI summary, sentiment and promises made, not its messages | read-only |
| comms.list_conversationsPOST /api/v1/comms/list_conversations | List inbox conversations with their latest message and unread state | read-only |
| comms.get_conversationPOST /api/v1/comms/get_conversation | Get one conversation: contact, status, assignee and last message time | read-only |
| comms.search_messagesPOST /api/v1/comms/search_messages | Search message text across every conversation in this shop | read-only |
| comms.update_conversationPOST /api/v1/comms/update_conversation | Mark a conversation read, done, pinned or assigned — not its messages | writes |
| comms.block_textingPOST /api/v1/comms/block_texting | Stop this shop texting one contact — the message opt-out switch | writes |
| comms.set_contact_languagePOST /api/v1/comms/set_contact_language | Set the language this contact's messages are translated into | writes |
| comms.list_messagesPOST /api/v1/comms/list_messages | List messages in one thread, or across the shop, newest first | read-only |
| comms.get_messagePOST /api/v1/comms/get_message | Get one message with its delivery status and who sent it | read-only |
| comms.send_messagePOST /api/v1/comms/send_message | Send a text message to one customer of this shop | writes · reaches the customer |
| comms.schedule_messagePOST /api/v1/comms/schedule_message | Queue a text or email message to a customer for a later time | writes · reaches the customer |
| comms.list_scheduled_messagesPOST /api/v1/comms/list_scheduled_messages | List messages queued to send later, soonest first | read-only |
| comms.cancel_scheduled_messagePOST /api/v1/comms/cancel_scheduled_message | Pull a scheduled message back before it is sent | writes |
| comms.list_phone_numbersPOST /api/v1/comms/list_phone_numbers | List the shop's phone numbers — which one calls, which one messages | read-only |
| comms.get_phone_numberPOST /api/v1/comms/get_phone_number | Get one of the shop's numbers: status, role and message sending | read-only |
| comms.resolve_contactPOST /api/v1/comms/resolve_contact | Find the customer a number belongs to, and whether we may message them | read-only |