startRealTimeNotificationsUsingPOST

Set Admin Credentials...
startRealTimeNotificationsUsingPOST

POST

startRealTimeNotificationsUsingPOST

Stream Types are different events that Plantronics Open Data Access supports as notifications- Link Quality events at the end of a call is an example.This request will start the notifications with the requested protocol.

Resource URL

https://oda-sandbox.plantronicsmanager.com /realtime/streams/notifications/start

Query Parameters

Name Values Description
apikey
(required)

Key to access this api.
tenantApiCode
(required)

Api Code of the tenant whose events the app is interested in.
streamType
(required)

Stream Type the notification is requested for

Header Parameters

Name Values Description
appId
(required)

ID of the partner app for which the stream id has subscription

Request Body

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...
Reset
Request Response cURL

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400

    Invalid stream creation body.

  • 401

    Unauthorized

  • 403

    Forbidden.

  • 404

    Not Found

Resource Summary

Security

Content Type

application/json

Category

Websockets Real-time

Name Type Description
Name Type Description

Working...