Firstly the below slide shows an overview of the 3 publicly-exposed APIs that the comprise Plantronics Spokes SDK:
Image 1 - Overview of the Spokes APIs
The Key Features of the Spokes SDK are as follows:
- Wearing Sensor
- Get initial wearing state, receive events when it changes
- Proximity
- Register for proximity, receive updates of user’s range to PC
- Mobile caller id / call management
- Caller id of incoming / outgoing mobile calls
- Dial / answer / reject / end of mobile call via Spokes API
- Serial number
- Programmable unique id per device
- Uses for asset tracking or application user personalisation
- Data Logging
- Log information about device usage as well as any information important to your application or other services, cloud applications etc.
- Call control
- Inform Spokes of inbound/outbound calls via high-level API
- No need to perform low-level device control
- Note: also be informed of on-going call progress in other softphone apps supported by Plantronics – multi softphone support
- Multi-line support
- Receive events to notify the calling status / held status of the 3 lines (PC, mobile and desk phone)
The following diagrams show more details of each of these features.
Image 2 - Detail of the Wearing Sensor feature
Image 3 - Detail of the Proximity feature.
There is some variability as to when the different proximity events occur, depending on device and local BlueTooth conditions
In determining availability proximity can be used to know for example your availability for:
- IM (Near)
- PC calling (Near, Far)
- Mobile calling (Near, Far, Out of range)
Image 4 - Detail of the Mobile Caller Id / Mobile Call Management features
The headset is paired to PC (via USB dongle), and to Mobile Phone.
When you receive an incoming call (at ringing stage) the Caller Id is passed to registered application via a Spokes Caller Id event.
You can use this Called Id to lookup the Caller details in database of your choice, and display this additional information in your app.
Your app can provide call controls to answer or reject, and end mobile call, or dial a new outbound mobile call.
The Caller Id received via a Spokes event for Incoming or Outgoing calls initiated on either the mobile phone or via the Spokes Mobile call control API feature.
This allows your app to lookup Caller details for both Incoming and Outgoing calls.
Image 5 - Detail of the Serial Number Feature
Image 6 - Detail of the Event Logging Feature*
*Note, the boxes for Lync and Skype signify all the Plantronics Spokes-supported softphones, including Avaya, Cisco, IBM, NEC and ShoreTel.
Image 7 - Detail of the High-Level Call Control Feature
Image 8 - Detail of the Multi-Line Support Features*
*Note, the boxes for Lync and Skype signify all the Plantronics Spokes-supported softphones, including Avaya, Cisco, IBM, NEC and ShoreTel.
For sample code, quick start guides and forum support, visit the on the Plantronics Developer Connection web site!
Have fun!
This article was written by Lewis Collins. Lewis became a member of the Plantronics Engineering team in August 2011. In this role he provides software consulting and expertise internally across teams and to external development partners who want to integrate with the Plantronics SDK kits and headset products. Previously Lewis gained experience in a wide range of software engineering activities and technologies, working in the telecommunications and public safety sectors as a software engineer at Integraph, a consultant for Altran Technologies UK and as a software engineer for Teleca Ltd.
