Guides
Introduction
Welcome to the Spoke Developer API. This API allows you to connect Spoke Phone and Spoke Enlighten to your existing business systems in a variety of ways:
- Access the Spoke Unified Directory via the Directory endpoint. This endpoint provides comprehensive details about each Directory entry, including Availability. You can read more about the Spoke Directory and its core concepts here
- Upload customer, supplier and other CRM contacts into Spoke Phone via the Phonebooks and Contacts endpoint. Once integrated, these contacts become searchable in the Spoke mobile application external phonebook. Any new incoming calls from phone numbers that have matching details in the phonebook will automatically show enhanced caller ID details.
- Access detailed call logs via the Calls endpoint. You can extract this data for reporting, real-time analytics or even integrate them back into customer records in your CRM system.
- View Spoke User status via the Users endpoint, and build a custom dashboard to see who is available in real-time.
- Add SIP trunk extensions to the Spoke Unified Directory by managing your Spoke SIP Trunk integration via the Trunks endpoint. Integrating with this endpoint and its associated Trunk Devices, Trunk Users and Trunk Queues endpoints allows you to synchronise your legacy internal phone directory with Spoke, giving your Spoke users a unified view across your entire organisation.
- Subscribe to webhook events so that your systems can be notified when call and conversation related events occur on the Spoke platform.
- Send system generated SMS messages via the Conversations
/conversationMessagesendpoint. The messages will be automatically added to the user's conversations in the Spoke application. - Create Data Actions to customise your call workflows
- Automatically analyse calls and conversations using the Spoke Enlighten AI Content Analysis
/contentAnalysisendpoint.
Access to the API
If you have a Spoke account, you can access the Spoke Developer API via https://integration.spokephone.com. This production endpoint provides access to your live user data.
If you do not have a Spoke account, you have two options:
- If you have your own Twilio account and want to deploy Spoke into that account, enabling you to integrate Spoke with other Twilio applications, go to https://account.spokephone.com/twilio to create a free developer account.
- If you want use Spoke's services without needing your own Twilio account, go to https://account.spokephone.com/signup to sign up for trial account.
Either account will allow you to get started and provides access to full production functionality.
Feedback
If you have requests, feedback or questions, please request to join the Spoke Phone Tech Community on Slack at https://spoke-phone-tech.slack.com
Last modified on