WebSocket API User Reference

The TelXL WebSocket API allows accredited organisations to interact with the TelXL platform using third-party applications. Via the API, authorised users may make and handle voice calls, manage operators and other company resources, and control various other facilities such as audio recording.

Pre-requisites

Before the API can be used by an organisation, it must be properly set up and licensed by the managing partner. When this is done, customer organisations may initiate WebSocket sessions and perform a wide range of operations (Commands), receiving a rich set of data (Events) in return.

Implementation

Typically, every WebSocket API session begins with a session_start command, and is kept active for as long as needed using session_ping commands.

Refer to the following topics for information about specific categories of API commands and events:

• API Reference: Operators
• API Reference: Operator Groups
• API Reference: Calls
• API Reference: Services
• API Reference: Queues
• API Reference: Phone Numbers
• API Reference: Website Users