RingCentral icon

RingCentral

Interact with RingCentral API - SMS, Voice, Fax, Meetings, and more

Presence → Get

AI-generated

Summary

Retrieves the presence status and telephony state for a specified RingCentral extension.

Inputs

  • authMode — Select saved RingCentral credentials or dynamic access token authentication.
  • accessToken — OAuth 2.0 access token used when Authentication Mode is set to Dynamic Access Token.
  • serverUrl — RingCentral API environment (Production or Sandbox) used when Authentication Mode is set to Dynamic Access Token.
  • extensionId (required) — The target extension ID to retrieve presence data for. Defaults to '~' for the currently authenticated user.
  • detailedTelephonyState — Whether to include detailed telephony state alongside active call details.

Output shape

a single record

Returns a JSON object detailing the extension's presence status, DND status, user status, and optional detailed telephony state.

Examples

Example 1: Get presence status for the current authenticated user

Set Extension to '~' and keep Detailed Telephony State set to false.

Example 2: Get detailed presence and active call info for a specific extension

Select the target extension from the Extension dropdown and set Detailed Telephony State to true.

Links

Discussion