Spoke API Reference

The Spoke Unified Directory is a comprehensive directory of all the users, teams and devices in your organisation. It is used to store and manage your legacy internal phone directory.

Users are the individual Spoke Users in your account. You can query this API to get all active users and their current system availability.

Teams are groups of Spoke Users and SIP Devices.

Phonebooks are containers that hold an organisation's contacts. Typically you will create one phonebook per integration (e.g. CRM) to store Contacts for that integration against.

Contacts represent external contacts to your organisation. Spoke uses contacts in each phonebook to identify incoming callers and to allow Spoke users to search and place calls.

Call related data for all calls made or received on the Spoke platform by your organisation. Query these endpoints to retrieve comprehensive call data records that can then be imported into a BI tool or stored as call activities in your CRM system.

Conversations represent long-running message threads between a Spoke user with an SMS enabled DDI and a customer of your organisation.

Transcripts represent written versions of audio content, typically transcribed from call or voicemail recordings made or received on the Spoke platform.

A content analysis job represents an AI-generated automated analysis of call recordings or transcripts. Running a content analysis job extracts key information from a recording or transcript into structured JSON payloads that can be used to drive downstream automation or systems integration.

Webhooks are a way to receive notifications when certain events happen in your Spoke account. For more information about webhooks, see Webhook Events.

Trunks represent SIP Trunks between the Spoke platform and your on-premise or legacy PBX platforms. Trunks can be created via the Spoke Account Portal

Trunk devices usually represent real phones in communal areas, such as a conference phone or lunch room phone.

Trunk queues usually represent call queues or hunt groups in your phone system.

Trunk users usually represent the individual users in your phone system who may have soft phones or desk phones.