Legacy v1 API

The previous-generation API. Migrate to CAPI.

This document describes the services exposed by the legacy v1 API. These services were primarily intended for 3rd-party systems that integrate with Telavox. The reader should be familiar with the end-user application and related concepts before implementing a client.

Accessing the API

The Telavox v1 API is located at https://api.telavox.se. All method paths are relative to this URL.

Authentication and sessions

When a user (web browser or API client) logs in with their username and password a session cookie is returned that is required for subsequent requests. A single user can have multiple active sessions at the same time. Requests that require authentication but are outside an active session respond with 401 Unauthorized.

Synchronization

Any data and configuration may be changed from another source. We recommend not storing a replica of data fetched from Telavox unless it is read very frequently and its accuracy isn't critical. When updating information, refresh it first to confirm no modification has been made from another source since it was retrieved.

Character encoding and request methods

The content type and encoding of each method is specified in the Content-Type response header. Most responses are JSON and UTF-8 encoded.

The character encoding used in request URLs is not well defined, so non-US-ASCII characters may not be portable. We strongly recommend specifying a Content-Type header on every request.

Read more

See the v1 reference for endpoint details. Reference →