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 Chats API

The Chats API from RingCentral — 6 operation(s) for chats.

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

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

This API exposes 6 operations across 6 paths, and defines 5 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.

6 operations 6 paths 5 schemas 4 GET2 POST

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 Chats 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 6

Across 6 paths, the API surfaces 6 operations — 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Chats 6
GET
/team-messaging/v1/recent/chats
List Recent Chats
listRecentChatsNew 2 params → 200400
GET
/team-messaging/v1/chats
List Chats
listGlipChatsNew 3 params → 200
GET
/team-messaging/v1/chats/{chatId}
Get Chat
readGlipChatNew 1 param → 200404
POST
/team-messaging/v1/chats/{chatId}/unfavorite
Remove Chat from Favorites
unfavoriteGlipChatNew 1 param → 204404
POST
/team-messaging/v1/chats/{chatId}/favorite
Add Chat to Favorites
favoriteGlipChatNew 1 param → 204400403404
GET
/team-messaging/v1/favorites
List Favorite Chats
listFavoriteChatsNew 1 param → 200400

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are TMChatInfo (9 properties), TMNavigationInfo (2 properties), TMChatList (2 properties), TMChatMemberInfo (1 property). Each schema is shown below with its type and property counts.

TMChatInfo
object
9 properties
TMChatListWithoutNavigation
object
1 property 1 required
TMChatList
object
2 properties 1 required
TMNavigationInfo
object
2 properties
TMChatMemberInfo
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-chats-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 Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API