Sign in

v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
Presence

Get User Presence Status

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 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.

get/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

extensionIdstring required

Internal identifier of the RingCentral extension/user (can be set to "~" to indicate that the extension associated with current authorization session should be used)

Query parameters

detailedTelephonyStateboolean

Specifies whether to return a detailed telephony state or not

sipDataboolean

Specifies whether to return SIP data or not

Response

OK

uristring uri

Canonical URI of a presence info resource

allowSeeMyPresenceboolean

If set to true - enables other extensions to see the extension presence status

callerIdVisibility'All' | 'None' | 'PermittedUsers'

Configures the user presence visibility. When the allowSeeMyPresence parameter is set to true, the following visibility options are supported via this parameter - All, None, PermittedUsers

dndStatus'TakeAllCalls' | 'DoNotAcceptAnyCalls' | 'DoNotAcceptDepartmentCalls' | 'TakeDepartmentCallsOnly'

Extended DnD (Do not Disturb) status. Cannot be set for Department/Announcement/Voicemail (Take Messages Only)/Fax User/Shared Lines Group/Paging Only Group/IVR Menu/Application Extension/Park Location extensions. The 'DoNotAcceptDepartmentCalls' and 'TakeDepartmentCallsOnly' values are applicable only for extensions

  • members of a Department; if these values are set for department outsiders, the 400 Bad Request error code is returned. The 'TakeDepartmentCallsOnly' status can be set through the old RingCentral user interface and is available for some migrated accounts only.
messagestring

Custom status message (as previously published by user)

pickUpCallsOnHoldboolean

If true enables the extension user to pick up a monitored line on hold

presenceStatus'Offline' | 'Busy' | 'Available'

Aggregated presence status, calculated from a number of sources

ringOnMonitoredCallboolean

If true enables to ring extension phone, if any user monitored by this extension is ringing

telephonyStatus'NoCall' | 'CallConnected' | 'Ringing' | 'OnHold' | 'ParkedCall'

Telephony presence status

userStatus'Offline' | 'Busy' | 'Available'

User-defined presence status (as previously published by the user)

meetingStatus'Connected' | 'Disconnected'

RingCentral Meetings presence