RingCentral
Cloud business phone and communication platform
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://platform.ringcentral.com/ | link | — | — | — |
Actions (50)
Administration · 9
- Create extensionPOST /restapi/v1.0/account/{accountId}/extension
Create a new user/extension under an account.
documented - Delete extensionDELETE /restapi/v1.0/account/{accountId}/extension/{extensionId}
Remove an extension.
documented - Get extensionGET /restapi/v1.0/account/{accountId}/extension/{extensionId}
Retrieve details for a specific extension.
documented - Get extension presenceGET /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence
Read presence for an extension.
documented - List account phone numbersGET /restapi/v1.0/account/{accountId}/phone-number
Discover phone numbers on the account.
documented - List audit trailGET /restapi/v1.0/account/{accountId}/audit-trail
Audit trail for account configuration changes (beta).
documented - List extensionsGET /restapi/v1.0/account/{accountId}/extension
List extensions on an account.
documented - Set extension presencePOST /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence
Set presence for an extension.
documented - Update extensionPUT /restapi/v1.0/account/{accountId}/extension/{extensionId}
Update extension attributes.
documented
Messages · 8
- Delete messageDELETE /restapi/v1.0/account/~/extension/~/message-store/{messageId}
Delete a message (two-step delete with purge also supported).
documented - Download message content attachmentGET /restapi/v1.0/account/~/extension/~/message-store/{messageId}/content/{attachmentId}
Download an attachment from a message store entry.
documented - Get messageGET /restapi/v1.0/account/~/extension/~/message-store/{messageId}
Retrieve details for a specific message in the store.
documented - List inbound faxesGET /restapi/v1.0/account/~/extension/~/message-store?direction=Inbound&messageType=Fax
List fax messages that were received inbound to the extension.
documented - List messages in storeGET /restapi/v1.0/account/~/extension/~/message-store
List messages (SMS, Fax, Voicemail, Pager, etc.) for an extension.
documented - Send FaxPOST /restapi/v1.0/account/~/extension/~/fax
Submit a fax for sending from an extension number.
documented - Send SMSPOST /restapi/v1.0/account/~/extension/~/sms
Send an SMS message from an extension phone number.
documented - Update message read statusPUT /restapi/v1.0/account/~/extension/~/message-store/{messageId}
Mark a message as Read or Unread.
documented
Notifications · 4
- Create event subscriptionPOST /restapi/v1.0/subscription
Create a webhook/websocket/PubNub subscription to receive RingCentral events.
documented - Delete subscriptionDELETE /restapi/v1.0/subscription/{subscriptionId}
Remove an existing event subscription.
documented - Get subscriptionGET /restapi/v1.0/subscription/{subscriptionId}
Retrieve details of a specific event subscription.
documented - Update subscriptionPUT /restapi/v1.0/subscription/{subscriptionId}
Modify an existing event subscription (e.g., change delivery mode or filters).
documented
Team Messaging · 4
- Create chatPOST /team-messaging/v1/chats
Create a new team chat.
documented - List chatsGET /team-messaging/v1/chats
List team chats.
documented - List postsGET /team-messaging/v1/chats/{chatId}/posts
List posts in a chat.
documented - Post messagePOST /team-messaging/v1/chats/{chatId}/posts
Post a message to a chat.
documented
Call Logs · 3
- List account call logsGET /restapi/v1.0/account/~/call-log
Retrieve call logs for the entire account (account-level data).
documented - List extension call logsGET /restapi/v1.0/account/~/extension/~/call-log
Retrieve call logs for the currently authenticated extension (extension-level data).
documented - List extension call logs (Detailed)GET /restapi/v1.0/account/~/extension/~/call-log?view=Detailed
Retrieve detailed call logs (CDRs) for an extension.
documented
Emergency Locations · 3
- Create company emergency locationPOST /restapi/v1.0/account/~/emergency-locations
Create a company-wide Emergency Response Location.
documented - Create user emergency locationPOST /restapi/v1.0/account/~/extension/~/emergency-locations
Create a user-specific Emergency Response Location for a single extension.
documented - List emergency locations (company)GET /restapi/v1.0/account/~/emergency-locations
List all company-wide emergency locations.
documented
Fax · 3
- List inbound faxesGET /restapi/v1.0/account/~/extension/~/message-store?direction=Inbound&messageType=Fax
List fax messages received inbound.
documented - Send FaxPOST /restapi/v1.0/account/~/extension/~/fax
Submit a fax for sending from an extension number.
documented - Send Fax (alternate)POST /restapi/v1.0/account/~/extension/~/fax
Submit a fax for sending from an extension number (alternate variant).
documented
Video · 3
- Create meeting bridgePOST /rcvideo/v2/account/~/extension/~/bridges
Create a new RingCentral Video bridge/meeting.
documented - Get bridgeGET /rcvideo/v2/account/~/extension/~/bridges/{bridgeId}
Get details for a specific video bridge/meeting.
documented - List bridgesGET /rcvideo/v2/account/~/extension/~/bridges
List RingCentral Video bridges for the authenticated user.
documented
Calling · 2
Presence · 2
- Get presenceGET /restapi/v1.0/account/~/extension/~/presence
Retrieve presence information for the authenticated user/extension.
documented - Read extension presencePOST /restapi/v1.0/account/~/extension/~/presence?detailedTelephonyState=true
Fetch presence with detailed telephony state for a specific extension.
documented