Introduction

Welcome to the Ubity API documentation.

The Ubity API is a simple HTTPS/REST-style API that gives your applications programmatic access to the Ubity telephony/UC platform. With it you can, among other things:

• initiate and control calls (answer, hang up, transfer, send to voicemail),
• place calls into your call queues, monitor those queues and manage their agents,
• send and receive text messages (SMS),
• browse your call history (CDR) and download your call recordings,
• get the live phone presence status of your users/extensions,
• be notified of call events on your account through HTTP callbacks.

All requests are made against the base URL:

https://api.ubity.com

Every request must be authenticated with an API key (see the Authentication section) and should carry an Accept header selecting the encoding and the API version (see the Requesting, headers and encoding section). Unless noted otherwise, replies share a common envelope containing at least code, diagnostic, stamp, url and version, alongside the data specific to the endpoint.

Sample code is available in Shell (curl) in the dark area to the right. The examples use placeholders such as KKKK (your API key), QQQQ (a queue name) or EEE (an extension); replace them with your own values.