How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RingCentral Contents API

The Contents API from RingCentral — 2 operation(s) for contents.

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

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

This API exposes 3 operations across 2 paths, and defines 50 schemas. It is described by OpenAPI 3.2.0, 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.

3 operations 2 paths 50 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
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 Contents 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 3

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

Contents 3
GET
/cx/social-messaging/v1/contents
List All Contents
socMsgListContents 10 params → 200400422
POST
/cx/social-messaging/v1/contents
Create Content
socMsgCreateContent body → 201400403404422
GET
/cx/social-messaging/v1/contents/{contentId}
Get Content
socMsgGetContent 1 param → 200404

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are ContentModel (32 properties), CreateContentRequest (15 properties), ContentAttachment (9 properties), NonEnumeratedPagingModel (5 properties). Each schema is shown below with its type and property counts.

ContentAttachmentIds
array
An array containing the attachment identifiers that need to be attached to the content.
ContentInterventionId
string
The intervention identifier of the content.
ContentAttachment
object
9 properties
ContentComponents
array
Applicable to WhatsApp channels only. Component configuration of the Whatsapp template to use for the content. All available components are visible on the What…
ContentStatuses
array
ContentPublic
boolean
True if the content is publicly visible on the remote channel (default). Private content is NOT supported on every channel.
NonEnumeratedPagingModel
object
5 properties 1 required
SocMsgLastModifiedTime
string
The time when the last modification was completed.
ContentAutoSubmittedField
boolean
Auto submitted content: - won't reopen tasks or interventions - can be used to send automatic messages like asking an user to follow on twitter, sending a surv…
ContentBody
string
The content's body. On creation this field is mandatory except for WhatsApp content using templates. The following are the max length restrictions for the diff…
ContentSourceId
string
Identifier of the channel. On creation if inReplyToContentId is specified, the channel will be determined from it. Otherwise, this parameter is mandatory.
SocMsgCreationTimeOrder
string
Ordering by creationTime is descending by default.
CreateContentRequest
object
15 properties
ContentType
string
Type of the content.
ContentCreatedFrom
string
Created from of the content.
ContentInReplyToContentId
string
The content identifier to which this content is a reply to. On creation, if omitted, a new discussion will be created. If the channel does not support to initi…
SocMsgCreationTime
string
Creation time of the resource.
ContentStatus
string
Content status.
ContentSynchronizationStatus
string
Synchronization status.
ContentCapabilitiesSupported
array
Types of structured messages that can be used to reply to this type of message.
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
AttachmentId
string
Attachment identifier.
ContentSynchronizationError
string
Synchronization error details.
ContentLanguage
string
Language of the content.
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
ContentEmailAddresses
array
Applicable on Email channels only. An array containing the email addresses used in sections of the email. This parameter is mandatory when initiating a discuss…
ContentTemplateName
string
Applicable to WhatsApp channels only. Name of the Whatsapp template to use for the content. All available template names are visible on the Whatsapp Business M…
ContentModel
object
32 properties 30 required
ContentRemotelyDeleted
boolean
True if the content has been deleted on the remote channel.
ContentBodyFormatted
object
Text and HTML formatted versions of the content body.
2 properties
ContentTitle
string
Applicable to Email channels only. The subject of the email. This field is mandatory when initiating a discussion.
ContentAttachments
array
An array containing the attachments that are attached to the content.
ContentSourceUri
string
External Uri of the content channel.
ContentInReplyToAuthorIdentityId
string
The identity identifier of the content to which this content is a reply to.
ContentCreatorId
string
RC user id of the creator
ContentPhoneNumbers
array
Applicable on SMS/WhatsApp channels only. Must be a phone number to which the message will be sent. It must be in the E.164 format. For example: +33634231224.…
ContentForeignCategories
array
External categories of the content. Present only if the content has foreignCategories.
ContentId
string
Identifier of the content.
ContentSourceType
string
Type of the channel.
ContentRating
integer
Rating of the content. Present only if the content supports rating and rating is filled.
SocMsgEmailAddress
string
Email address.
ContentList
object
2 properties 2 required
ContentBodyInputFormat
string
Values can be Text or Html.
SocMsgPhoneNumber
string
Phone number.
ContentContextData
object
Additional data of the content. The contextData hash keys are the custom fields keys.
ContentThreadId
string
Content thread identifier of the content.
ContentTemplateLanguage
string
Applicable to WhatsApp channels only. Language of the Whatsapp template to use for the content. All available template languages are visible on the Whatsapp Bu…
ContentAuthorIdentityId
string
Identity identifier of the author of content. Not mandatory on creation, by default it uses the token's user first identity on channel.
ContentCategoryIds
array
List of the category identifiers of the content.
ContentPublished
boolean
True if the content is published on the remote channel.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-contents-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
Where this information came from

This is an independent, third-party profile of RingCentral Contents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.