---
title: "Get User Presence Status"
method: GET
path: "/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence"
tags: ["Presence"]
---

# Get User Presence Status

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

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.

## Path parameters

- `accountId` string, required
- `extensionId` string, required

## Query parameters

- `detailedTelephonyState` boolean
- `sipData` boolean

## Response `200`

OK

- GetPresenceInfo
  - `uri` string, uri — Canonical URI of a presence info resource
  - `allowSeeMyPresence` boolean — 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.
  - `extension` GetPresenceExtensionInfo — Information on extension, for which this presence data is returned
    - `id` integer — Internal identifier of an extension
    - `uri` string, uri — Canonical URI of an extension
    - `extensionNumber` string — Extension number (usually 3 or 4 digits)
  - `message` string — Custom status message (as previously published by user)
  - `pickUpCallsOnHold` boolean — 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
  - `ringOnMonitoredCall` boolean — 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
  - `activeCalls` ActiveCallInfo[] — Information on active calls
    - `id` string
    - `direction` 'Inbound' | 'Outbound'
    - `queueCall` boolean — Identifies if a call belongs to the call queue
    - `from` string — Phone number or extension number of a caller. For GCM transport type '_from' property should be used
    - `fromName` string — Name of a caller
    - `to` string — Phone number or extension number of a callee
    - `toName` string — Name of a callee
    - `startTime` string, date-time — Time when the call is actually started
    - `telephonyStatus` 'NoCall' | 'CallConnected' | 'Ringing' | 'OnHold' | 'ParkedCall' — Telephony presence status
    - `sipData` DetailedCallInfo
      - `callId` string
      - `toTag` string
      - `fromTag` string
      - `remoteUri` string, uri
      - `localUri` string, uri
      - `rcSessionId` string
    - `sessionId` string
    - `telephonySessionId` string — Telephony identifier of a call session
    - `onBehalfOf` string — Extension ID of the call owner on whose behalf a call is performed
    - `partyId` string — Internal identifier of a call party
    - `terminationType` string
    - `callInfo` CallInfoCQ — Primary/additional CQ information
      - `primary` PrimaryCQInfo — Primary call session information. Supported for Call Queues only
        - `type` 'PhoneNumberLabel' | 'PhoneNumber' | 'QueueExtension' | 'QueueName' | 'CallerIdName' | 'CallerIdNumber' | 'None' — Call information to be displayed as 'Line 1' for a call queue call session
        - `value` string — Call information value
      - `additional` AdditionalCQInfo — Additional call session information. Supported for Call Queues only
        - `type` 'PhoneNumberLabel' | 'PhoneNumber' | 'QueueExtension' | 'QueueName' | 'CallerIdName' | 'CallerIdNumber' | 'None' — Call information to be displayed as 'Line 2' for a call queue call session
        - `value` string — Call information value

---

[API](https://skmtc.net/ringcentral/apis/ringcentral-api.md) · [All operations](https://skmtc.net/ringcentral/apis/ringcentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringcentral/ringcentral-api/revisions/8d602198ec97/schema)