spokephone_list_calls
List calls
List call records (oldest first by default; pass sortOrder descending for the latest calls), with caller, direction, duration, assigned user/team and recording URLs. Filter by time window or the external party's number. Returns { meta: { next }, calls }.
ParametersnextlimitsincebeforemodifiedsortOrdercontactNumberincludeActiveincludeRecordingUrl
spokephone_get_call
Get a call
Get one call record by call id.
ParametersidrequiredincludeRecordingUrl
spokephone_get_call_recording
Get a call recording
Get the details and download URL of one recording of a call.
ParametersidrequiredrecordingIdrequired
spokephone_list_call_content_analysis
List a call's AI analysis
List the Enlighten AI content-analysis results (summaries etc.) stored for one call.
Parametersidrequirednextlimitartifact
spokephone_list_directory
List the directory
List or search the unified Spoke directory (users, teams, devices) with extensions and live availability. Exactly one of extension, phoneNumber or ivrKey may be used to look up an entry. Returns { meta: { next }, entries }.
ParametersnextlimitivrKeyextensionphoneNumberincludeSuspendedUsersincludeHiddenCallGroups
spokephone_get_directory_entry
Get a directory entry
Get one directory entry (user, team or device) by entry id.
ParametersentryIdrequired
spokephone_list_users
List users
List active Spoke users with real-time availability. Optionally filter by email address.
Parametersemail
spokephone_get_user
Get a user
Get one Spoke user with availability, by user id.
Parametersidrequired
spokephone_list_teams
List teams
List Spoke teams (call groups) with their members and availability.
Parametersnextlimit
spokephone_list_locations
List locations
List the locations of the organisation.
Parametersnextlimit
spokephone_get_location
Get a location
Get one location by id.
ParameterslocationIdrequired
spokephone_list_location_users
List a location's users
List the users assigned to one location.
ParametersnextlimitlocationIdrequired
spokephone_list_phonebooks
List phonebooks
List shared phonebooks (the CRM contact containers used for caller ID), each with its contacts. Use limit 0 to list phonebooks without contacts.
ParameterslimitsearchexcludeEmpty
spokephone_get_phonebook
Get a phonebook
Get one phonebook and a page of its contacts. The id may also be a user's email address for that user's personal phonebook.
Parametersidrequirednextlimitsearch
spokephone_get_phonebook_contact
Get a phonebook contact
Get one contact of a phonebook.
ParametersidrequiredcontactIdrequired
spokephone_list_transcripts
List transcripts
List call and voicemail transcripts. Filter by time window or source.
ParametersnextlimitsincebeforesourceIdsourceContextId
spokephone_get_transcript
Get a transcript
Get one transcript by id.
Parametersidrequired
spokephone_get_transcript_segments
Get transcript segments
Get the per-speaker segments of one transcript.
Parametersidrequired
spokephone_list_content_analysis
List AI content analysis
List AI content-analysis results (needs the Enlighten entitlement). Filter by time, source, participant or artifact name.
ParametersnextlimitsincebeforeartifactsourceIdcontactNumberparticipantId
spokephone_get_content_analysis
Get an AI content analysis
Get one content-analysis result by id.
Parametersidrequired
spokephone_list_webhooks
List webhooks
List the webhook subscriptions of the account.
Parametersnextlimit
spokephone_get_webhook
Get a webhook
Get one webhook subscription by id.
Parametersidrequired
spokephone_list_trunks
List SIP trunks
List the SIP trunks that overlay a legacy PBX onto Spoke.
Parametersnextlimit
spokephone_get_trunk
Get a SIP trunk
Get one SIP trunk by id.
ParameterstrunkIdrequired
spokephone_send_sms
Send an SMS
WRITE: send a real SMS to a phone number (or a group MMS to several) from a company number or from a Spoke user's conversation number. The message appears in the Spoke conversation. Confirm the recipient and text with the user first. Needs an SMS-enabled number. POST /conversationMessages.
ParameterstorequiredbodyrequiredconfirmrequiredfromNumberassignUsersfromUserEmailroutingActionconversationNamenotificationMode
spokephone_save_phonebook_contact
Add or replace a phonebook contact
WRITE: add a contact to a phonebook, REPLACING any contact there with the same contactId (other contacts are untouched). The phonebook id may be a user's email for a personal phonebook. Contacts feed caller ID. PUT /phonebooks/{id}/contacts.
ParametersemailsjobTitlelastNamecontactIdfirstNamecountryIsocompanyNamephonebookIdrequiredphoneNumbersrequired
spokephone_delete_phonebook_contact
Delete a phonebook contact
WRITE, destructive: delete one contact from a phonebook (it stops showing in caller ID). DELETE /phonebooks/{id}/contacts/{contactId}.
ParametersconfirmrequiredcontactIdrequiredphonebookIdrequired