Sky Hosted API services enable applications running on a desktop to interact or control phones through a simple Web API (Application Programming Interface). By utilizing CTI (Computer Telephony Integration) technology, Sky Hosted API services enable both PC and web-based applications to interact with your Sky phone system.
Because the service is hosted by RingCentral and accessed by an API, it is anticipated that no additional libraries or software need to be installed by application developers or users.
For the complete list of Hosted API services, see Application Integration Solutions.
Features
Sky Hosted API provides the following features in a client's application:
- Click-to-dial - A user can click to dial a phone number or contact record and the Sky phone will dial that number.
- Screen Pop - A user can interact with "screen pop" dialogs that appear when a Sky phone rings, presenting the caller's relevant information on the user's desktop.
- Remote Call Control: Most Sky phone features can be controlled on the application screen. Users can "click-to" dial calls, answer incoming calls, place calls on hold, transfer calls, send calls to voicemail, etc.
Call Controls
Sky Hosted API provides the following call control functions in a customer's application:
- Dialing out to a phone number
- Answering an incoming call
- Ignoring an incoming call
- Transferring a call to another number or extension
- Placing a call on hold
- Resuming a held call
- Hanging up an active call
- Listing current active calls
- Subscribing to receive live call events
NOTE: Sky Hosted API does not provide the following:
- The ability to park or unpark a call.
- History of calls. Call history may be obtained by using the DataExport API.
API Overview
The Sky Hosted API is available at the following publicly known URL: hostedconnect.m5net.com. All communication occurs over a secured HTTPS connection.
You can use the following two ways to communicate with the API, both of which receive XML fragments in response:
- GET requests with the parameters encoded in the URL
- POST requests with an XML command fragment sent as POST data
For more involved integrations, the API supports long-lived HTTP 1.1 connections where commands can be sent asynchronously. To utilize this, the HTTP client library used must be able to support keep-alive sessions and support HTTP 1.1 chunk encoding.
API Documentation
The full API documentation is available upon request. Please contact Support to receive the API documentation.
SDK and Examples
Sky has SDKs in both Java and C# that are available to customers. Both come with basic command-line examples that can be used to test the API. These SDKs can be used in your project or examined to see how to create your own library. Please contact support to request it.
Requesting Sky Hosted API Service
To inquire about utilizing this service in your organization, contact Support.
