Q-loud REST API Documentation¶
This document defines and describes the application programming interface (API). All of the functionality is exposed via the API, in fact, even the web-interface is a HTML5 application (“AJAX”) that solely relies on the API outlined in this document with no additional features. With this full-featured coverage, the API allows for almost unlimited possibilies to integrate its features into third-party systems, interfaces and products.
The API is completely based on HTTP and follows a REST architecture, using JSON to encapsulate and serialize object data where applicable. This approach enables rapid integration of the API because of a simple, well-understood architecture and information content that can easily be read by both human beings and machines.
Through the use of a “comet-like” functionality within the
GET /api/event
API call, the API also features “push-style”
notifications that effectively enable “real-time” capabilities for automated
data processing within the platform. A broad range of specific events
enable the client to stay informed about events and data object
generated by other users. These events are also specified
in this document.
- Example API Usage
- Generic API Request Considerations
- API Call Reference (User API)
- /api/session
- /api/signup
- /api/password
- /api/language
- /api/user
- /api/user/picture
- /api/user/invitation
- /api/user/link
- /api/phone
- /api/tag
- /api/trash
- /api/object
- /api/fax
- /api/recording
- /api/announcement
- /api/contact
- /api/conference
- /api/volume
- /api/box
- /api/ipquality
- /api/sip
- /api/presentation
- /api/chat
- /api/call
- /api/sensor
- /api/xobject
- /api/event
- Dialplan API
- Interactive Voice Response API
- Event Reference
- Generic Event JSON Considerations
- User events
- Invitation events
- Phone events
- Tag events
- Trash events
- Generic object events
- Comment events
- Metadata events
- Fax events
- Announcement events
- Conference events
- File events
- Box events
- Dialplan events
- SIP events
- Presentation events
- Chat events
- Call events
- Sensor events
- Apple Push Notifications & Google Cloud Messaging
- Partner API
- Calling Name Delivery
- Rules API
- Device API
- Internal API
- Change Log
- Version 1.16.0
- Version 1.15.0
- Version 1.14.0
- Version 1.13.0
- Version 1.12.0
- Version 1.11.0
- Version 1.10.0
- Version 1.9.0
- Version 1.8.0
- Version 1.7.0
- Version 1.6.0
- Version 1.5.0
- Version 1.4.0
- Version 1.3.0
- Version 1.2.0
- Version 1.1.1
- Version 1.1.0
- Version 1.0.39
- Version 1.0.38
- Version 1.0.37
- Version 1.0.36
- Version 1.0.35
- Version 1.0.34
- Version 1.0.33
- Version 1.0.32
- Version 1.0.31
- Version 1.0.30
- Version 1.0.29
- Version 1.0.28
- Version 1.0.27
- Version 1.0.26
- Version 1.0.25
- Version 1.0.24
- Version 1.0.23
- Version 1.0.22
- Version 1.0.21
- Version 1.0.20
- Version 1.0.19
- Version 1.0.18
- Version 1.0.17
- Version 1.0.16
- Version 1.0.15
- Version 1.0.14
- Version 1.0.13
- Version 1.0.12
- Version 1.0.11
- Version 1.0.10
- Version 1.0.9
- Version 1.0.8
- Version 1.0.7
- Version 1.0.6
- Version 1.0.5
- Version 1.0.4
- Version 1.0.3
- Version 1.0.2
- Version 1.0.1
- Version 1.0.0