Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RingCentral Presence API

The Presence API from RingCentral — 5 operation(s) for presence.

RingCentral Presence API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Presence. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 5 paths, and defines 50 schemas. It is described by OpenAPI 3.0.3, at version 1.0.58-20240529-47eda8bd.

Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.

9 operations 5 paths 50 schemas 5 GET1 PATCH3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.58-20240529-47eda8bd
Servers
https://platform.ringcentral.com
https://media.ringcentral.com
https://platform.devtest.ringcentral.com
https://platform.devtest.ringcentral.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral Presence API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 5 GET, 1 PATCH, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Presence 9
GET
/restapi/v1.0/account/{accountId}/call-queues/{groupId}/presence
Get Call Queue Presence
readCallQueuePresence 2 params → 200
PUT
/restapi/v1.0/account/{accountId}/call-queues/{groupId}/presence
Update Call Queue Presence
updateCallQueuePresence 2 params body → 200
GET
/restapi/v1.0/account/{accountId}/presence
Get User Presence Status List
readAccountPresence 5 params → 200
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-queue-presence
Get Agent’s Call Queue Presence
readExtensionCallQueuePresence 3 params → 200
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-queue-presence
Update Call Queue Presence
updateExtensionCallQueuePresence 2 params body → 200
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence
Get User Presence Status
readUserPresenceStatus 4 params → 200
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence
Update User Presence Status
updateUserPresenceStatus 2 params body → 200
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/unified-presence
Get Unified Presence
readUnifiedPresence 2 params → 200207400404
PATCH
/restapi/v1.0/account/{accountId}/extension/{extensionId}/unified-presence
Update Unified Presence
updateUnifiedPresence 2 params body → 200400403404

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are MissedCallEvent (20 properties), IncomingCallEvent (20 properties), ActiveCallInfo (16 properties), ActiveCallInfoWithoutSIP (14 properties). Each schema is shown below with its type and property counts.

GetPresenceInfo
object
13 properties
PresencePagingInfo
object
Information on paging
6 properties
UnifiedPresenceGlip
object
Returned if Glip feature is switched on
3 properties
ExtensionCallQueuePresence
object
2 properties
CallQueueMember
object
Call queue member information
4 properties
SiteResource
object
Site extension information
2 properties
ExtensionPresenceEvent
object
5 properties
PresenceInfoRequest
object
7 properties
DetailedExtensionPresenceEvent
object
5 properties
APNSInfo
object
APNS (Apple Push Notification Service) information
1 property
APSInfo
object
APS (Apple Push Service) information/ priority data
1 property
GetPresenceExtensionInfo
object
Information on extension, for which this presence data is returned
3 properties
PrimaryCQInfo
object
Primary call session information. Supported for Call Queues only
2 properties
AdditionalCQInfo
object
Additional call session information. Supported for Call Queues only
2 properties
CallQueueUpdateMemberPresence
object
2 properties
CallQueuePresenceEventBody
object
Notification payload body
3 properties
ActiveCallInfo
object
16 properties
CallQueueId
object
Call queue information
1 property
UpdateUnifiedPresenceGlip
object
2 properties
CallQueuePresence
object
1 property
CallQueuePresenceEvent
object
5 properties
DetailedExtensionPresenceEventBody
object
Notification payload body
13 properties
ExtensionCallQueuePresenceList
object
1 property
IncomingCallEvent
object
20 properties
UnifiedPresenceMeeting
object
Returned if Meetings feature is switched on
1 property
CallQueueMemberId
object
Call queue member information
1 property
UnifiedPresence
object
4 properties
UnifiedPresenceList
array
MissedCallEvent
object
20 properties
CallQueueUpdatePresence
object
1 property
PresenceCallQueueInfo
object
Call queue information
4 properties
CallQueueMemberPresence
object
3 properties
AccountPresenceInfo
object
4 properties
PresenceNavigationInfoURI
object
Canonical URI for the corresponding page of the list
1 property
ExtensionCallQueueUpdatePresenceList
object
1 property
DetailedCallInfo
object
6 properties
ExtensionCallQueueUpdatePresence
object
2 properties
DetailedExtensionPresenceWithSIPEvent
object
5 properties
PresenceInfoResponse
object
13 properties
UpdateUnifiedPresence
object
2 properties
ActiveCallInfoWithoutSIP
object
14 properties
UnifiedPresenceListEntry
object
3 properties
UpdateUnifiedPresenceTelephony
object
1 property
DetailedExtensionPresenceWithSIPEventBody
object
Notification payload body
13 properties
AccountPresenceEventBody
object
Notification payload body
10 properties
PresenceNavigationInfo
object
Information on navigation
4 properties
CallInfoCQ
object
Primary/additional CQ information
2 properties
ExtensionPresenceEventBody
object
10 properties
UnifiedPresenceTelephony
object
Returned if BLF feature is switched on
3 properties
AccountPresenceEvent
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-presence-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API
RingCentral Contact Center API