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 Adaptive Cards API

The Adaptive Cards API from RingCentral — 2 operation(s) for adaptive cards.

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

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

This API exposes 4 operations across 2 paths, and defines 17 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.

4 operations 2 paths 17 schemas 1 DELETE1 GET1 POST1 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 Adaptive Cards 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 4

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

Adaptive Cards 4
POST
/team-messaging/v1/chats/{chatId}/adaptive-cards
Create Adaptive Card
createGlipAdaptiveCardNew 1 param body → 201400403404
GET
/team-messaging/v1/adaptive-cards/{cardId}
Get Adaptive Card
getGlipAdaptiveCardNew 1 param → 200207400404
PUT
/team-messaging/v1/adaptive-cards/{cardId}
Update Adaptive Card
updateGlipAdaptiveCardNew 1 param body → 200400403404
DELETE
/team-messaging/v1/adaptive-cards/{cardId}
Delete Adaptive Card
deleteGlipAdaptiveCardNew 1 param → 204400403404

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are AdaptiveCardInfo (17 properties), AdaptiveCardRequest (11 properties), AdaptiveCardColumnItemInfo (8 properties), AdaptiveCardShortInfo (8 properties). Each schema is shown below with its type and property counts.

AdaptiveCardColumnInfo
object
3 properties
AdaptiveCardSelectAction
object
An action that will be invoked when the card is tapped or selected. Action.ShowCard is not supported
1 property 1 required
BackgroundImage
object
Specifies a background image oa a card. Acceptable formats are PNG, JPEG, and GIF
5 properties 1 required
AdaptiveCardInfoRequestItem
object
5 properties
AdaptiveCardRequest
object
11 properties 2 required
AdaptiveCardCreator
object
1 property
ImageFillMode
Describes how the image should fill the area
HorizontalAlignment
Describes how the image should be aligned if it must be cropped or if using repeat fill mode
AdaptiveCardInfo
object
17 properties
AdaptiveCardInfoRequest
object
2 properties
VerticalContentAlignment
Defines how the content should be aligned vertically within the container. Only relevant for fixed-height cards, or cards with a minHeight specified
AdaptiveCardAction
object
4 properties
VerticalAlignment
Describes how the image should be aligned if it must be cropped or if using repeat fill mode
AdaptiveCardShortInfo
object
8 properties
ActionCardBody
object
4 properties
AdaptiveCardColumnItemInfo
object
8 properties
ActionAdaptiveCardInfo
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-adaptive-cards-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