Package com.ringcentral.paths.restapi.oauth.wstoken

Class Index

java.lang.Object

com.ringcentral.paths.restapi.oauth.wstoken.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc

Constructor Summary

Constructors

Constructor	Description
Index(Index parent)

Method Summary

Modifier and Type	Method	Description
String	path()
String	path(Boolean withParameter)
WsTokenResponse	post()	Returns a special short lived token to authorize a dedicated web socket connection between this client and a backend.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

rc

public RestClient rc

parent

public Index parent

Constructor Details

Index

public Index(Index parent)

Method Details

path

public String path()

path

public String path(Boolean withParameter)

post

public WsTokenResponse post()
                     throws RestException,
IOException

Returns a special short lived token to authorize a dedicated web socket connection between this client and a backend.

This API needs to be called if a client plans to use "Websocket" transport to receive RingCentral push notifications. The token returned by this API should be provided when establishing a connection to the RingCentral Websocket Gateway.

HTTP Method: post Endpoint: /restapi/oauth/wstoken Rate Limit Group: Auth App Permission: WebSocket

Throws:

RestException

IOException