Plantronics Developer Connection - Real-time

Plantronics Developer Connection - Real-time https://developer.plantronics.com/blog/real-time en Real-time Events https://developer.plantronics.com/article/real-time-events <div class="field field-name-field-keywords field-type-taxonomy-term-reference field-label-above"> <div class="field-label">Keywords: </div> <div class="field-items"> <span class="field-item even label label-default keyword-label"><a href="/blog/real-time" typeof="skos:Concept" property="rdfs:label skos:prefLabel" datatype="">Real-time</a></span> </div> </div><div class="field field-name-body field-type-text-with-summary field-label-hidden"><div class="field-items"><div class="field-item even" property="content:encoded">This table documents real-time events available as of 3.11.0 PM Pro API release:<br /> <table align="center" border="1" cellpadding="1" cellspacing="1" style="width:900px;" summary="The realtime event documentation shows how to trigger these events from Plantronics devices and the data format for the events through pubnub stream "> <caption>Real-time Event Descriptions</caption> <thead> <tr> <th scope="col" style="width: 55px;">Event</th> <th scope="col" style="width: 104px;">Type</th> <th scope="col" style="width: 184px;">Description</th> <th scope="col" style="width: 250px;">Response Sample</th> <th scope="col" style="width: 84px;">Protocol</th> </tr> </thead> <tbody> <tr> <td style="width: 55px;">Mute on<sup>*</sup></td> <td style="width: 104px;">Raw</td> <td style="width: 184px;">This event is triggered when Mute button is pressed from the headset</td> <td style="width: 250px;">{<br /> "eventType": "isMute",<br /> "product": {<br /> "headset": "",<br /> "baseId": "0AGUEX"<br /> },<br /> "timeStamp": "2018-01-22T21:25:32.344452Z",<br /> "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",<br /> "isMute": "true"<br /> }<br /> </td> <td style="width: 84px;">Pubnub</td> </tr> <tr> <td style="width: 55px;">Mute off<sup>*</sup></td> <td style="width: 104px;">Raw</td> <td style="width: 184px;">This event is triggered when the user un-mutes from the headset<br /> </td> <td style="width: 250px;">{<br /> "eventType": "isMute",<br /> "product": {<br /> "headset": "",<br /> "baseId": "0AGUEX"<br /> },<br /> "timeStamp": "2018-01-22T21:25:32.344452Z",<br /> "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",<br /> "isMute": "true"<br /> }<br /> </td> <td style="width: 84px;">Pubnub</td> </tr> <tr> <td style="width: 55px;">Quick<br /> connect</td> <td style="width: 104px;">Raw</td> <td style="width: 184px;">This event is triggered when the headset is connected<br /> (e.g. DA90 connectors)</td> <td style="width: 250px;">{<br /> "eventType": "isConnected",<br /> "product": {<br /> "headset": "0BG8UK",<br /> "baseId": "0AGUEX"<br /> },<br /> "timeStamp": "2018-01-22T21:33:27.883175Z",<br /> "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",<br /> "isConnected": "true"<br /> }<br /> </td> <td style="width: 84px;">Pubnub</td> </tr> <tr> <td style="width: 55px;">Quick<br /> disconnect</td> <td style="width: 104px;">Raw</td> <td style="width: 184px;">This event is triggered when the headset is disconnected<br /> (e.g. DA90 connectors)<br /> </td> <td style="width: 250px;">{<br /> "eventType": "isConnected",<br /> "product": {<br /> "headset": "",<br /> "baseId": "0AGUEX"<br /> },"timeStamp": "2018-01-22T21:33:21.703756Z",<br /> "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",<br /> "isConnected": "false"<br /> }</td> <td style="width: 84px;">Pubnub</td> </tr> <tr> <td style="width: 55px;">Headset talk button</td> <td style="width: 104px;">Raw</td> <td style="width: 184px;">This event is triggered when the call is answered by pressing the call button on the headset<br /> </td> <td style="width: 250px;">{<br /> "eventType": "HEADSET_BUTTON_TALK",<br /> "product": {<br /> "headset": "0BG8UK",<br /> "baseId": "0AGUEX"<br /> },<br /> "timeStamp": "2018-01-22T21:37:07.764642Z",<br /> "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",<br /> "isHeadSetTalk": "true"<br /> }<br /> </td> <td style="width: 84px;">Pubnub</td> </tr> <tr> <td style="width: 55px;">Headset reject button</td> <td style="width: 104px;">Raw</td> <td style="width: 184px;">This event is triggered when the call is rejected by long-pressing the call button on the headset<br /> </td> <td style="width: 250px;">{<br /> "eventType": "HEADSET_BUTTON_REJECT",<br /> "product": {<br /> "headset": "",<br /> "baseId": "S/N0KTH5M"<br /> },<br /> "timeStamp": "2018-01-22T23:03:53.826856Z",<br /> "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",<br /> "isHeadSetTalk": "false"<br /> }<br /> </td> <td style="width: 84px;">Pubnub</td> </tr> <tr> <td style="width: 55px;">Headset DON</td> <td style="width: 104px;">Raw</td> <td style="width: 184px;">This event is triggered when the user wears the headset</td> <td style="width: 250px;">{<br /> "eventType": "HS_STATE_CHANGE_DON",<br /> "product": {<br /> "headset": "",<br /> "baseId": ""<br /> },<br /> "timeStamp": "2018-01-22T21:39:28.741616Z",<br /> "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326","isDon": "true"<br /> }<br /> </td> <td style="width: 84px;">Pubnub</td> </tr> <tr> <td style="width: 55px;">Headset DOFF</td> <td style="width: 104px;">Raw</td> <td style="width: 184px;">This event is triggered when the user removes the headset</td> <td style="width: 250px;">{<br /> "eventType": "HS_STATE_CHANGE_DOFF",<br /> "product": {<br /> "headset": "",<br /> "baseId": ""<br /> },<br /> "timeStamp": "2018-01-22T21:40:02.288749Z",<br /> "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",<br /> "isDon": "false"<br /> }<br /> </td> <td style="width: 84px;">Pubnub</td> </tr> <tr> <td style="width: 55px;">Call event</td> <td style="width: 104px;">Raw</td> <td style="width: 184px;">This event is triggered when the call is initiated/ended.</td> <td style="width: 250px;">{<br /> "eventType": "CALL_EVENT",<br /> "relatedDeviceEvent": "",<br /> "userAction": "softphoneUI",<br /> "lineType": "VOIP",<br /> "pluginId": "2100",<br /> "callId": "39432832041432742996",<br /> "deviceId": "441A49D95E781546A1174A4AEBA40095",<br /> "source": "Microsoft Lync & Skype for Business",<br /> "type": "call",<br /> "eventTime": "2018-01-22T21:43:30.616683Z",<br /> "sessionId": "eb3633e0-b22e-4837-9c31-08991eb99d9a",<br /> "duration": 7000,<br /> "softphoneVersion": "16.0.8730.2127",<br /> "direction": "outgoing",<br /> "name": "ended",<br /> "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",<br /> "product": {<br /> "headset": "",<br /> "baseId": ""<br /> }<br /> }<br /> </td> <td style="width: 84px;">Pubnub</td> </tr> <tr> <td style="width: 55px;">Conversation Dynamic Event</td> <td style="width: 104px;">Raw</td> <td style="width: 184px;">This event is sent periodically every second or what is configured in PM Pro.</td> <td style="width: 250px;">{<br /> "eventType": "CD_EVENT",<br /> "rxLevelIn": -53,<br /> "periodicity": 1000,<br /> "overTalk": 308,<br /> "txLevelOut": -51,<br /> "farTalk": 81,<br /> "nearTalk": 0,<br /> "rxLevelOut": -63,<br /> "rxNoiseIn": -73,<br /> "rxNoiseOut": -82,<br /> "rxPeakIn": -16,<br /> "rxPeakOut": -17,<br /> "rxVolume": -24,<br /> "sideToneVolume": 0,<br /> "txLevelIn": -55,<br /> "txNoiseIn": -69,<br /> "txNoiseOut": -64,<br /> "txPeakIn": -15,<br /> "txPeakOut": -14,<br /> "txVolume": 4,<br /> "timeStamp": "2018-03-26T19:28:02.059547Z",<br /> "callId": "16175850011970936251",<br /> "tenantId": "2e183738-772f-4fbc-b8a7-0214ee283379",<br /> "product": {<br /> "headset": "S/N123456",<br /> "baseId": "0AGUEC"<br /> }<br /> }</td> <td style="width: 84px;">Pubnub</td> </tr> <tr> <td style="width: 55px;">Link Quality (LQ) notification</td> <td style="width: 104px;">Aggregated</td> <td style="width: 184px;">This event is generated at the end of a call with the aggregated LQ metrics for the call.</td> <td style="width: 250px;"> </td> <td style="width: 84px;">WebSockets (native)</td> </tr> </tbody> </table> <br /> <br /> * <span style="color: rgb(37, 36, 36); font-family: "Segoe UI", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 14px; background-color: rgb(255, 255, 255);">any of the Plantronics Hub supported headsets</span></div></div></div> Wed, 14 Mar 2018 21:55:49 +0000 mramakrishnan 1422 at https://developer.plantronics.com https://developer.plantronics.com/article/real-time-events#comments