An agent is an extension that answers the calls of one or more queues. These endpoints manage queue agents: log an agent in or out of one or more queues, pause/unpause an agent (a paused agent stays logged in but temporarily stops receiving queue calls), and get an agent's …
A call detail record (CDR) is written for every call handled by the platform: who called whom, when, for how long, through which queue or conference, and how the call ended. These endpoints return the call detail records (call history) of your account, one month or one day at a …
A call queue holds incoming calls and distributes them to the agents logged into it. These endpoints report the live state (who is logged in, who is available, how many calls are waiting) and the historical statistics of the call queues of your account, and let you adjust the penalty …
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:
To interact with the Ubity API, you will need an API key. You can request an API key by writing to Ubity Support.
The Ubity API expects an API key to be included in all API requests to
the server as part of the GET or POST parameters, using the …
Most endpoints support both GET and POST. Parameters may be
passed as query-string parameters, as form-encoded POST data, or as a
JSON body (with Content-Type: application/json); the three forms are
equivalent, and a few endpoints whose parameters are lists — this is
then documented — require the JSON body form.
You …
These endpoints let your application place calls on behalf of your users and control the calls in progress on your account: list them, answer them, send them to voicemail or hang them up. A typical click-to-call integration only needs /call; supervision or screen-pop applications will also use /calls and the …
Initiate a call and place it in a queue.
This is the "call back" building block: instead of connecting the called party to a specific user (as /call does), the call is placed into one of your call queues and will be distributed …
This endpoint allows your application to get a list of your company's users, or extensions, as well as their current phone presence status (free, oncall).
Each entry is keyed by the extension number and contains the
callerid (the display name of the user), the current state, and …
This endpoint delivers a text message (SMS) to a mobile phone number, from one of the phone numbers of your account.
On success, the reply contains a smsid, a unique identifier you can
keep to correlate the message with delivery notifications or with
your own records.
POST /sms
GET /sms …
These endpoints give access to the call recordings of your account: browse them as a hierarchy (year / month / day / direction), download or delete individual recordings, retrieve a recording directly from a call id received in a callback, and pause the recording in the middle of a call. To find the …
Event Callbacks are used to notify your application whenever particular events occur on the Ubity telephony/UC platform. These events can range from a user making or receiving a call, to a call being answered or ended.
Callbacks turn the API around: instead of your application polling the platform, the …