RingCentral Conversations API
The Conversations API from RingCentral — 2 operation(s) for conversations.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/ringcentral-conversations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: RingCentral Adaptive Cards Conversations API
description: RingCentral API specification
version: 1.0.58-20240529-47eda8bd
contact:
name: RingCentral Developers Support
url: https://developers.ringcentral.com/support
termsOfService: https://www.ringcentral.com/legal/apilitos.html
license:
name: RingCentral API License Agreement
url: https://www.ringcentral.com/legal/apilitos.html
servers:
- url: https://platform.ringcentral.com
description: Production API entry point
- url: https://media.ringcentral.com
description: Production Media entry point
- url: https://platform.devtest.ringcentral.com
description: Developer sandbox API entry point
- url: https://platform.devtest.ringcentral.com
description: Developer sandbox Media entry point
security:
- OAuth2: []
tags:
- name: Conversations
paths:
/team-messaging/v1/conversations:
get:
tags:
- Conversations
summary: List Conversations
description: Returns the list of conversations where the user is a member. All records in response are sorted by creation time of a conversation in ascending order. Conversation is a chat of the *Group* type.
operationId: listGlipConversationsNew
parameters:
- name: recordCount
in: query
description: Number of conversations to be fetched by one request. The maximum value is 250, by default - 30
schema:
maximum: 250
type: integer
format: int32
default: 30
- name: pageToken
in: query
description: Pagination token.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TMConversationList'
x-feature: TeamMessaging
x-throttling-group: Medium
x-app-permission: TeamMessaging
post:
tags:
- Conversations
summary: Create/Open Conversation
description: Creates a new conversation or opens the existing one. If the conversation already exists, then its ID will be returned in response. A conversation is an adhoc discussion between a particular set of users, not featuring any specific name or description; it is a chat of 'Group' type. If you add a person to the existing conversation (group), it creates a whole new conversation.
operationId: createGlipConversationNew
requestBody:
description: JSON body
content:
application/json:
schema:
$ref: '#/components/schemas/CreateConversationRequest'
required: true
responses:
'200':
description: Conversation is opened
content:
application/json:
schema:
$ref: '#/components/schemas/TMConversationInfo'
'201':
description: Conversation is created
content:
application/json:
schema:
$ref: '#/components/schemas/TMConversationInfo'
'400':
description: Some of the parameters are missing or have invalid format
x-feature: TeamMessaging
x-throttling-group: Medium
x-app-permission: TeamMessaging
/team-messaging/v1/conversations/{chatId}:
get:
tags:
- Conversations
summary: Get Conversation
description: Returns information about the specified conversation, including the list of conversation participants. A conversation is an adhoc discussion between a particular set of users, not featuring any specific name or description; it is a chat of 'Group' type. If you add a person to the existing conversation, it creates a whole new conversation.
operationId: readGlipConversationNew
parameters:
- name: chatId
in: path
description: Internal identifier of a conversation to be returned.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TMConversationInfo'
'404':
description: Conversation Not Found.
x-feature: TeamMessaging
x-throttling-group: Light
x-app-permission: TeamMessaging
components:
schemas:
CreateConversationRequest:
required:
- members
type: object
properties:
members:
type: array
description: 'Identifier(s) of chat member(s). The maximum supported number
of IDs is 15. User''s own ID is optional. If `members` section is omitted
then "Personal" chat will be returned
'
items:
type: object
properties:
id:
type: string
description: Internal identifier of a person
email:
type: string
format: email
description: Email of a person
TMChatMemberInfo:
type: object
properties:
id:
type: string
description: Internal identifier of a user
TMConversationList:
required:
- records
type: object
properties:
records:
type: array
description: List of conversations
items:
$ref: '#/components/schemas/TMConversationInfo'
navigation:
$ref: '#/components/schemas/TMNavigationInfo'
TMConversationInfo:
type: object
properties:
id:
type: string
description: Internal identifier of a conversation
type:
type: string
description: Type of conversation
enum:
- Direct
- Personal
- Group
creationTime:
type: string
description: Conversation creation datetime in ISO 8601 format
format: date-time
lastModifiedTime:
type: string
description: Conversation last change datetime in ISO 8601 format
format: date-time
members:
type: array
items:
$ref: '#/components/schemas/TMChatMemberInfo'
TMNavigationInfo:
type: object
properties:
prevPageToken:
type: string
description: Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens
nextPageToken:
type: string
description: Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens
securitySchemes:
OAuth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://platform.ringcentral.com/restapi/oauth/authorize
tokenUrl: https://platform.ringcentral.com/restapi/oauth/token
refreshUrl: https://platform.ringcentral.com/restapi/oauth/token
scopes: {}
x-tagGroups:
- name: Voice
popular: true
tags:
- Business Hours
- Call Blocking
- Call Control
- Call Forwarding
- Call Handling Rules
- Interaction Rules
- State-based Rules
- Call Flip
- Call Log
- Call History
- Call Log Export
- Call Monitoring Groups
- Call Queues
- Call Recordings
- Call Recording Settings
- Device SIP Registration
- Greetings
- IVR
- RingOut
- Verification Calls
- name: SMS and Fax
popular: true
tags:
- Fax
- Message Exports
- Message Store
- Pager Messages
- SMS
- High Volume SMS
- SMS Log Export
- SMS Templates
- Voicemail Broadcasting
- name: Social Messaging
popular: true
tags:
- Identities
- Contents
- name: Team Messaging
popular: true
tags:
- Adaptive Cards
- Bots
- Calendar Events
- Chats
- Conversations
- Compliance Exports
- Contacts
- Incoming Webhooks
- Notes
- Posts
- Profile
- Tasks
- Teams
- name: Video
popular: true
tags:
- Bridge Management
- Delegation Management
- Meetings History
- Meeting Recordings
- RCM Meetings (Legacy)
- RCM Webinars (Legacy)
- name: Webinar
popular: true
tags:
- Webinars and Sessions
- Invitees
- Historical Webinars
- Historical Recordings
- Registration Management
- Registrants
- Webinar Analytics
- Webinar Subscriptions
- name: Analytics
popular: true
tags:
- Business Analytics
- name: Artificial Intelligence
popular: true
tags:
- Insights
- Audio
- Text
- Status
- name: Authentication
tags:
- OAuth 2.0 / OpenID Connect
- Interoperability
- name: Account
tags:
- Company
- Custom Fields
- Features
- Licenses
- Tax Locations
- Cost Centers
- Multi-Site
- Phone Numbers
- Presence
- Regional Settings
- User Permissions
- User Settings
- Audit Trail
- Calling Rates
- Appearance Customization
- Account Integrations
- name: Provisioning
tags:
- Automatic Location Updates
- Devices
- Extensions
- Paging Only Groups
- Park Locations
- Phone Lines
- SCIM
- Shared Lines
- Group Call Pickup
- Delegated Lines Groups
- Directed Call Pickup
- IVR Apps
- Video Configuration
- Number Porting
- SMB
- Account Federation
- Integrations
- Enterprise Portal API
- Push to Talk Provisioning
- BYOC
- name: Address Book
tags:
- External Contacts
- Internal Contacts
- Hybrid Directory Contacts
- Overlay Contacts
- External Shared Directory
- name: Roles and Permissions
tags:
- Permissions
- Role Management
- Site Administration
- User Groups
- name: Events & Notifications
tags:
- Subscriptions
- name: User Integrations
tags:
- Token Management
- Calendar Management
- Calendar Event Management
- Calendar Presence Link
- Cloud Personal Contacts
- Cloud Shared Contacts
- Cloud Directory
- Deprecated Calendar API
- name: Rooms
tags:
- Rooms Client API
- Rooms Management API
- name: App Management
tags:
- App Gallery
- App Rating Review
- Bot Provisioning
- name: Workflow Builder
tags:
- Flows
- Flow Editor
- Flow Log
- Flow Templates
- name: Utilities
tags:
- API Info
- Application Settings
- Async Tasks
- User Notifications
- Client Versions
- End-to-End Encryption