# Spoke Phone Developer API

> The Spoke Phone Developer API connects the Spoke Phone business communications platform to your own systems: query call data, send and manage SMS and WhatsApp conversations, sync CRM contacts into the Spoke Unified Directory for enhanced caller ID, track real-time user and team availability, run AI content analysis on call recordings and transcripts, overlay SIP trunks onto legacy PBX systems, customise call and conversation flows with Data Actions, and subscribe to webhook events.

REST/JSON API. Base URL: `https://integration.spokephone.com`. Authentication uses an API key exchanged for an OAuth 2.0 bearer token, sent as `Authorization: Bearer <token>`. The reference is a single-page document; links below are deep anchors into it.

## Getting Started

- [Introduction](https://developer.spokephone.com/#section/Introduction): What the API does and how it fits with your systems.
- [Access to the API](https://developer.spokephone.com/#section/Introduction/Access-to-the-API): How to get access.
- [Authentication](https://developer.spokephone.com/#section/Authentication): API key and OAuth 2.0 token flow.
- [Create an API key](https://developer.spokephone.com/#section/Authentication/Create-an-API-key)
- [Generate a Token](https://developer.spokephone.com/#section/Authentication/Generate-a-Token)
- [Make Authenticated Requests](https://developer.spokephone.com/#section/Authentication/Make-Authenticated-Requests)
- [Access Token Expiration](https://developer.spokephone.com/#section/Authentication/Access-Token-Expiration)

## API Guide

- [Requests and Responses](https://developer.spokephone.com/#section/API-Guide/Requests-and-Responses)
- [Pagination](https://developer.spokephone.com/#section/API-Guide/Pagination)
- [DateTime Values](https://developer.spokephone.com/#section/API-Guide/DateTime-Values)
- [Last-Modified Timestamp](https://developer.spokephone.com/#section/API-Guide/Last-Modified-Timestamp)
- [Batch Operations](https://developer.spokephone.com/#section/API-Guide/Batch-Operations)
- [Upload Limits](https://developer.spokephone.com/#section/API-Guide/Upload-Limits)
- [Postman Collection](https://developer.spokephone.com/#section/API-Guide/Postman-Collection)

## Core Concepts

- [The Spoke Directory](https://developer.spokephone.com/#section/Core-Concepts/The-Spoke-Directory)
- [Calls on Spoke](https://developer.spokephone.com/#section/Core-Concepts/Calls-on-Spoke)
- [Company Contacts in Spoke](https://developer.spokephone.com/#section/Core-Concepts/Company-Contacts-in-Spoke)
- [Extensions](https://developer.spokephone.com/#section/Core-Concepts/Extensions)

## Call Routing & Webhooks

- [Routing Twilio Calls into Spoke](https://developer.spokephone.com/#section/Routing-Twilio-Calls-into-Spoke): Use Spoke's Redirect Handler or Twilio Voice Application Connect to route Twilio calls, override timeouts, set priority, and send to voicemail.
- [Webhook Events](https://developer.spokephone.com/#section/Webhook-Events): Delivery, retries, event ordering, and example timelines.
- [Securing Your Webhooks](https://developer.spokephone.com/#section/Webhook-Events/Securing-Your-Webhooks)

## Data Actions

- [Data Action Concepts](https://developer.spokephone.com/#tag/Data-Action-Concepts): How Data Actions customise organisation-specific workflows, with delivery and security.
- [Inbound Conversations](https://developer.spokephone.com/#tag/Inbound-Conversations): Programmatically handle new inbound conversations (auto-responses, claim rules).
- [Insights](https://developer.spokephone.com/#tag/Insights): Enrich and customise the customer information shown to agents.
- [Outbound Call](https://developer.spokephone.com/#tag/Outbound-Call): Override the configuration of an outbound call as it is placed.
- [Team Call](https://developer.spokephone.com/#tag/Team-Call): Override team configuration before a call is offered to a team.

## Deep Linking

- [Spoke App Deep Linking](https://developer.spokephone.com/#tag/Spoke-App-Deep-Linking): Route to app resources or trigger actions via spoke:// links.
- [Call History](https://developer.spokephone.com/#tag/Call-History): spoke://call/{callId} — open a specific call's details.
- [Dial](https://developer.spokephone.com/#tag/Dial): spoke://dial — dial a number with a chosen caller ID.
- [Message](https://developer.spokephone.com/#tag/Message): spoke://message — start or continue an SMS or WhatsApp conversation.

## Directory

- [Directory](https://developer.spokephone.com/#tag/Directory): The Spoke Unified Directory of all users, teams and devices in your organisation.
- [Users](https://developer.spokephone.com/#tag/Users): Active Spoke users and their real-time availability.
- [User Events](https://developer.spokephone.com/#tag/User-Events): Webhook events for user availability changes.
- [Teams](https://developer.spokephone.com/#tag/Teams): Groups of Spoke users and SIP devices.
- [Team Events](https://developer.spokephone.com/#tag/Team-Events): Webhook events for team availability changes.

## CRM Integration

- [Phonebooks](https://developer.spokephone.com/#tag/Phonebooks): Containers holding an organisation's contacts, typically one per integration.
- [Contacts](https://developer.spokephone.com/#tag/Contacts): External contacts used for caller-ID matching and in-app search.
- [Contact Events](https://developer.spokephone.com/#tag/Contact-Events): Webhook events for contact changes (e.g. contact shared).

## Calls

- [Calls](https://developer.spokephone.com/#tag/Calls): Query call data records for every call on the platform; export for BI or CRM.
- [Call Events](https://developer.spokephone.com/#tag/Call-Events): Webhook events across the call lifecycle (started, answered, ended, recording, transcript).

## Conversations

- [Conversations](https://developer.spokephone.com/#tag/Conversations): Long-running SMS and WhatsApp threads; send via the Messages and Team Messages APIs.
- [Conversation Events](https://developer.spokephone.com/#tag/Conversation-Events): Webhook events for conversation activity (message, assignment, inactivity, close).

## Spoke Intelligence

- [Transcripts](https://developer.spokephone.com/#tag/Transcripts): Written transcriptions of call and voicemail recordings, including per-segment access.
- [Transcript Events](https://developer.spokephone.com/#tag/Transcript-Events): Webhook events for transcript creation.
- [Content Analysis](https://developer.spokephone.com/#tag/Content-Analysis): AI analysis jobs over recordings or transcripts, extracting structured JSON.
- [Content Analysis Events](https://developer.spokephone.com/#tag/Content-Analysis-Events): Webhook events for completed content-analysis jobs.

## Webhook Management

- [Webhooks](https://developer.spokephone.com/#tag/Webhooks): Create, read, update and delete webhook subscriptions.

## PBX Overlay

- [Trunks](https://developer.spokephone.com/#tag/Trunks): SIP trunks between Spoke and your on-premise or legacy PBX.
- [Trunk Devices](https://developer.spokephone.com/#tag/Trunk-Devices): Communal phones such as conference or lunch-room devices.
- [Trunk Queues](https://developer.spokephone.com/#tag/Trunk-Queues): Call queues or hunt groups in your phone system.
- [Trunk Users](https://developer.spokephone.com/#tag/Trunk-Users): Individual PBX users with soft phones or desk phones.

## Optional

- [Sample Integrations](https://developer.spokephone.com/#section/Sample-Integrations): Worked examples (Microsoft Power Automate to Dynamics 365, Twilio Studio).
- [Changelog](https://developer.spokephone.com/#section/Changelog): Dated history of API changes.
- [Terms of Service](https://www.getspoke.com/legal/terms-of-use)