Comprehensive API documentation extracted from the Vaspian Silhouette Public API Guide R10.13.0.0.

This documentation covers the user-facing (Public) API that enables third-party applications to control calls, monitor presence, and provision the phone system via REST + WebSocket.

Quick Links

Authentication & Access

API Query Features

Third Party Call Control (3PCC)

WebSocket Events Reference

Provisioning Resources Index

Error Codes Reference

Architecture Overview

The Public API is a REST/HATEOAS web service with WebSocket support for real-time events.

• Entry Point: https://xtone.buf.vaspian.net/api
• HAL Browser: https://xtone.buf.vaspian.net/api/browser/browser.html
• WebSocket: wss://xtone.buf.vaspian.net/api/ws
• WSTool: https://xtone.buf.vaspian.net/api/wstool/wstool.html
• Protocol: REST (JSON) + WebSocket
• Media Types: application/json (request), application/hal+json (response)
• TLS: v1.2 with ECDHE_* cipher suites