Package com.ringcentral.paths.restapi.account.extension.presence

Class Index

java.lang.Object

com.ringcentral.paths.restapi.account.extension.presence.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
GetPresenceInfo	get()
GetPresenceInfo	get(ReadUserPresenceStatusParameters queryParams)	Returns the presence status of an extension or several extensions by their ID(s).
String	path()
String	path(Boolean withParameter)
PresenceInfoResponse	put(PresenceInfoRequest presenceInfoRequest)	Updates user-defined extension presence status, status message and DnD status by extension ID.

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)

get

public GetPresenceInfo get(ReadUserPresenceStatusParameters queryParams)
                    throws RestException,
IOException

Returns the presence status of an extension or several extensions by their ID(s). The `presenceStatus` is returned as Offline (the parameters `telephonyStatus`, `message`, `userStatus` and `dndStatus` are not returned at all) for the following extension types: Department/Announcement Only/Take Messages Only (Voicemail)/Fax User/Paging Only Group/Shared Lines Group/IVR Menu/Application Extension/Park Location. If the user requests his/her own presence status, the response contains actual presence status even if the status publication is turned off. [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported. For batch requests the number of extensions in one request is limited to 30. If more extensions are included in the request, the error code 400 Bad Request is returned with the logical error code InvalidMultipartRequest and the corresponding message Extension Presence Info multipart request is limited to 30 extensions.

HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/presence Rate Limit Group: Light App Permission: ReadPresence User Permission: ReadPresenceStatus

Throws:

RestException

IOException

get

public GetPresenceInfo get()
                    throws RestException,
IOException

Throws:

RestException

IOException

put

public PresenceInfoResponse put(PresenceInfoRequest presenceInfoRequest)
                         throws RestException,
IOException

Updates user-defined extension presence status, status message and DnD status by extension ID. Supported for regular User extensions only. The extension types listed do not support presence status: Department, Announcement Only, Take Messages Only (Voicemail), Fax User, Paging Only Group, Shared Lines Group, IVR Menu, Application Extension. HTTP Method: put Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/presence Rate Limit Group: Medium App Permission: EditPresence

Throws:

RestException

IOException