Reference · Customer API (CAPI) — Telavox Developer Portal

Stable

JavaScript-disabled view. The interactive reference renders client-side. This is a static endpoint catalog; the full OpenAPI document is at /api/spec/capi?v=v1.

Assortment

GET /v1/assortment/addons/{user} — Lists all purchasable addons
GET /v1/assortment — Lists all available assortments options for the different combinations of country and currency available
GET /v1/assortment/{country} — Lists all available assortments options for the different currencies in the the supplied country
GET /v1/assortment/{country}/{currency} — Lists all available assortments for the supplied country and currency available
GET /v1/assortment/{country}/{currency}/pbx-licenses — Lists all purchasable PBX licenses for the supplied country
GET /v1/assortment/{country}/{currency}/user-licenses — Lists all purchasable licenses for the supplied country

Products

POST /v1/products/addons/{user}/{assortment-item} — Buy an addon
GET /v1/products/addons/{user} — Lists all current addons for an extension
DELETE /v1/products/addons/{user}/{product} — Removes a currently existing addon for an extension
GET /v1/products/pbx-licenses/{country} — List all currencies that have available licenses
GET /v1/products/pbx-licenses — List the country and currency for the Pbx License
POST /v1/products/pbx-licenses/{country}/{currency}/{assortment-item} — Purchase a pbx license
GET /v1/products/pbx-licenses/{country}/{currency} — Get the active Pbx license
GET /v1/products — Available product resources in this api.
GET /v1/products/user-licenses/{country}/{currency}/unassigned — List all owned licenses that are currently not assigned to a user
GET /v1/products/user-licenses/{country}/{currency}/assigned — List all owned licenses that are currently assigned to a user
GET /v1/products/user-licenses/{country} — List all currencies that have available licenses
GET /v1/products/user-licenses — List all countries and currencies that have available licenses
POST /v1/products/user-licenses/{country}/{currency}/{assortment-item} — Purchase a user license
GET /v1/products/user-licenses/{country}/{currency} — List all licenses belonging to the customer
DELETE /v1/products/user-licenses/{country}/{licenseType} — Cancel an unused license of the customer
DELETE /v1/products/user-licenses/{product} — Cancel a specified unused license of the customer
GET /v1/products/user-licenses/{country}/{currency}/metadata — Returns the number of licenses that are currently not assigned to any user

Calls

POST /v1/extensions/users/me/hangup — Hang up any ongoing call for current user
POST /v1/extensions/users/me/dial — Dial particular number
GET /v1/extensions/{extension}/calls — Get information about ongoing calls for a user extension
GET /v1/extensions/users/me/calls/history — List my call history

Other

GET /v1 — Available resources in this api.

Contacts

GET /v1/contacts/colleagues — List contacts for all colleagues
PUT /v1/contacts/colleagues — Update contacts for all colleagues
GET /v1/contacts/colleagues/{user} — Get the contact of a specific colleague
PUT /v1/contacts/colleagues/{user} — Update user contact details
GET /v1/contacts/schema — List all visible contact fields for colleagues
POST /v1/contacts/schema — Create a new contact field, visible on all colleagues
DELETE /v1/contacts/schema/{field} — Completely remove a contact field, deleting all values for this field for all colleagues
GET /v1/contacts — List available contact resources in this api
PUT /v1/contacts — Update contacts for all users and pbxs
GET /v1/contacts/pbx/{extension} — Get the contact card of a single PBX service
PUT /v1/contacts/pbx/{extension} — Update the editable contact fields of a PBX service (e.g. CNAP)
GET /v1/contacts/pbx — List the contact cards of all PBX services
PUT /v1/contacts/pbx — Update the contact cards of multiple PBX services at once
GET /v1/contacts/templates/{template} — Get the contact of a template
PUT /v1/contacts/templates/{template} — Update template contact details

Delivery Places

PUT /v1/delivery-places/{delivery-place}/mass-assign — Add users to an existing delivery-place.
GET /v1/delivery-places — Available delivery places for the customer.
POST /v1/delivery-places — Create a delivery place.

Extended Transcriptions

GET /v1/extensions/extendedTranscriptions/{extendedTranscription} — Get a business extended transcription by key
GET /v1/extensions/users/me/extendedTranscriptions — List my business extended transcriptions
GET /v1/extensions/extendedTranscriptions/calls/{callRecord} — Get a business extended transcription by call record ID
GET /v1/extensions/{extension}/extendedTranscriptions — List business extended transcriptions for an extension

Extensions

GET /v1/extensions/users/{user}/sip — Get the SIP registrations for the specified user
GET /v1/extensions — Available extension resources in this api.
GET /v1/extensions/users/user-access/{user}/passwordreset — Receive a password reset URL for a user
POST /v1/extensions/users/user-access/{user}/passwordreset — Send a password reset email to the user
POST /v1/extensions/users/user-access/{user}/onboarding-mail — Send an onboarding email to the user
GET /v1/extensions/users — List all users
POST /v1/extensions/users — Create a new user
GET /v1/extensions/users/{user} — List information for a user
PUT /v1/extensions/users/{user} — Update a user
DELETE /v1/extensions/users/{user} — Completely remove a user
GET /v1/extensions/users/{user}/licenses — List the users licenses
DELETE /v1/extensions/users/{user}/licenses/{license} — Downgrade the user to the basic license. This will not cancel the license. The license will be added back into the customer license pool. It is not possible to delete a bundle license which has a capability required by other bundles.
POST /v1/extensions/users/{user}/replace — Replace a user by creating a new user and copying all important settings from the old user.
PUT /v1/extensions/users/{user}/replace — Replace a user by updating some of the most important settings.
GET /v1/extensions/users/{user}/language/app — Get current user app language
PUT /v1/extensions/users/{user}/language/app — Update user app language
GET /v1/extensions/language/app — List all available languages for the app
GET /v1/extensions/users/{user}/language/voice — Get current user voice language
PUT /v1/extensions/users/{user}/language/voice — Update user voice language
GET /v1/extensions/language/voice — List all available languages for voices

Pbx

GET /v1/extensions/pbx/faxes — List Faxes
POST /v1/extensions/pbx/faxes — Create new Fax
GET /v1/extensions/pbx/faxes/{fax} — Get the details for a specific fax
PUT /v1/extensions/pbx/faxes/{fax} — Update a specific fax
GET /v1/extensions/pbx/ivrs — List all ivrs
POST /v1/extensions/pbx/ivrs — Create a new ivr
GET /v1/extensions/pbx — List all pbx extensions
GET /v1/extensions/pbx/{extension} — Get a pbx extension using the extension key
DELETE /v1/extensions/pbx/{extension} — Delete a pbx extension
GET /v1/extensions/pbx/resources — List the currently available pbx related resources
GET /v1/extensions/pbx/queues/{extension}/calls — Get information about ongoing calls for a queue extension, both currently queued and answered calls
GET /v1/extensions/pbx/queues/{extension}/members — Get members of a queue
POST /v1/extensions/pbx/queues/{extension}/members — Add member to a queue
DELETE /v1/extensions/pbx/queues/{extension}/members — Remove members from a queue
PUT /v1/extensions/pbx/queues/{extension}/members/swap/{member-1}/{member-2} — Change position of two members in the queue
PUT /v1/extensions/pbx/queues/{extension}/members/{member}/call-type/{call-type} — Update queue member call type
PUT /v1/extensions/pbx/queues/{extension}/members/{member}/move-up — Move up a member in a queue
GET /v1/extensions/pbx/queues/{extension}/members/{member} — Get a queue member using a specific key
PUT /v1/extensions/pbx/queues/{extension}/members/{member}/move-down — Move down a member in a queue
GET /v1/extensions/pbx/queues/{extension}/delayed-groups — Get all delayed groups of a queue
GET /v1/extensions/pbx/queues — List all queues
POST /v1/extensions/pbx/queues — Create a new queue
GET /v1/extensions/pbx/queues/{queue} — Get queue settings
PUT /v1/extensions/pbx/queues/{queue} — Update queue settings
GET /v1/extensions/pbx/shared-voicemail/{voicemail} — Get a shared voicemail extension using the extension key
PUT /v1/extensions/pbx/shared-voicemail/{voicemail} — Update shared voicemail settings
GET /v1/extensions/pbx/shared-voicemail — List all shared voicemail extensions
POST /v1/extensions/pbx/shared-voicemail — Create a new shared voicemail

Groups

GET /v1/groups/{groupKey}/members — List the direct members of a group.
PUT /v1/groups/{groupKey}/members — Add members to a group.
DELETE /v1/groups/{groupKey}/members — Remove members from a group.
PUT /v1/groups/{groupKey}/members/{memberKey}/move-up — Move a group member up in the ordering.
PUT /v1/groups/{groupKey}/members/{memberKey}/move-down — Move a group member down in the ordering.
PUT /v1/groups/{groupKey} — Rename an existing group.
DELETE /v1/groups/{groupKey} — Delete a group by its key.
GET /v1/groups — List all groups for the customer.
POST /v1/groups — Create a new group, optionally with a name.

Invoice Places

GET /v1/invoice-places/{country} — Available invoice places in the supplied country.
GET /v1/invoice-places — Available invoice places for the customer.
GET /v1/invoice-places/{country}/{currency} — Available invoice places in the supplied country, with the supplied currency.
PUT /v1/invoice-places/{invoice-place} — Add users to an existing invoice-place.

Numbers

GET /v1/phone-numbers/main — List all numbers that can be used as a display number by any extension
POST /v1/phone-numbers/main — Make a number usable as a display number by any extension
POST /v1/phone-numbers/main/bulk — Make numbers usable as display number by any extension
DELETE /v1/phone-numbers/main/{main-phone-number} — Remove possibility of a number to be used as a display number by any extension
GET /v1/phone-numbers — List all owned phone numbers
GET /v1/reserved-phone-numbers — List owned unused phone numbers
POST /v1/reserved-phone-numbers — Reserve numbers
GET /v1/reserved-phone-numbers/available — Get all free available phone numbers
DELETE /v1/reserved-phone-numbers/bulk — Cancel owned unused phone numbers
DELETE /v1/reserved-phone-numbers/{number} — Cancel an owned unused phone number

SMS

POST /v1/extensions/users/me/sms — Send SMS to a particular number

Users

GET /v1/extensions/users/mobile-data-usage/{from}/{to} — List mobile data usage for all users
GET /v1/extensions/users/permissions/available — List available permissions
POST /v1/extensions/users/permissions/{permission} — Give a permission to all supplied users
DELETE /v1/extensions/users/permissions/{permission} — Remove a permission from all supplied users
GET /v1/extensions/users/permissions — List all permissions for all users
GET /v1/extensions/users/{user}/permissions — List all permissions for all users

Places

GET /v1/places — List available places for the customer.

Recorded Calls

GET /v1/extensions/{extension}/recordedCalls — Lists all recorded calls available for download
GET /v1/extensions/users/calls/recordings/{recordedCall} — Download a call recording
GET /v1/extensions/users/me/calls/recordings — List of Recorded calls
GET /v1/extensions/recordedCalls/{recordedCall} — Download a call recording

Profiles

PUT /v1/templates/{template}/profiles/{profile} — Update a profile setting for a template.
GET /v1/templates/{template}/profiles — List all template profiles
PUT /v1/templates/{template}/profiles — Update all profiles of a template with the supplied settings.
POST /v1/extensions/users/{user}/profiles/reset — Reset a user's profiles from a template
PUT /v1/extensions/users/{user}/profiles/active/{profile} — Activate one of a user's profiles
GET /v1/extensions/users/{user}/profiles/active — Get a user's currently active profile and its scheduled end time
PUT /v1/extensions/users/{user}/profiles/{profile} — Update the settings of a single profile
GET /v1/extensions/users/{user}/profiles — List all profiles configured for a user
PUT /v1/extensions/users/{user}/profiles — Update the settings of all of a user's profiles at once
GET /v1/extensions/users/me/profiles — List the authenticated user's availability profiles
PUT /v1/extensions/users/me/profiles/active/{profile} — Activate one of the authenticated user's profiles

Templates

GET /v1/templates — List all templates
POST /v1/templates — Create a new template
PUT /v1/templates/{template} — Update a template
DELETE /v1/templates/{template} — Delete a template

Terminals

GET /v1/terminals/{terminal} — Get a single registered terminal.
PUT /v1/terminals/{terminal} — Update a terminal.
DELETE /v1/terminals/{terminal} — Unregister a terminal, deleting all settings
PUT /v1/terminals/{terminal}/reboot — Reboot a terminal.
PUT /v1/terminals/{terminal}/resync — Resync a terminal.
PUT /v1/terminals/{terminal}/reset — Reset a terminal.
GET /v1/terminals — List all registered terminals.
POST /v1/terminals — Register a new terminal.
GET /v1/terminals/models/supported — List all supported terminal models
PUT /v1/terminals/{terminal}/authorize — Authorize the terminal for a "first" provisioning, e.g. without a second-factor authentication.
GET /v1/terminals/{terminal}/status — Get terminal status.
DELETE /v1/terminals/bulk — Unregister terminals, deleting all settings
GET /v1/terminals/models — List all registered terminal models

Credentials

DELETE /v1/extensions/users/{user}/credentials/delete-all — Deletes all credential of a user that are deletable
DELETE /v1/extensions/users/{user}/credentials/{credential}/delete — Deletes a credential of a user if it is deletable
GET /v1/extensions/users/{user}/credentials — Gets all credentials for a user or filters credentials based on the query param credentialType
POST /v1/extensions/users/{user}/credentials — Creates a new email credential with verifying state for a user. An email will be sent to given email for verification.Any existing email under verification will be removed.Once new email is verified it will replace existing email having validated state if any

Voicemail

PUT /v1/extensions/users/{user}/voicemail — Update a voicemail password

Loading interactive reference…