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.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.
3 operations2 paths50 schemas2 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
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
socMsgListContents10 params→ 200400422
POST
/cx/social-messaging/v1/contents
Create Content
socMsgCreateContentbody→ 201400403404422
GET
/cx/social-messaging/v1/contents/{contentId}
Get Content
socMsgGetContent1 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.
ContentRemotelyDeleted
boolean
True if the content has been deleted on the remote channel.
ContentType
string
Type of the content.
AttachmentId
string
Attachment identifier.
ApiError
object
Generalized API error structure suitable for any error type
2 properties2 required
ContentAttachments
array
An array containing the attachments that are attached to the content.
ContentTitle
string
Applicable to Email channels only. The subject of the email. This field is mandatory when initiating a discussion.
ContentForeignCategories
array
External categories of the content. Present only if the content has foreignCategories.
NonEnumeratedPagingModel
object
5 properties1 required
SocMsgCreationTimeOrder
string
Ordering by creationTime is descending by default.
ContentLanguage
string
Language of the content.
ContentModel
object
32 properties30 required
ContentCategoryIds
array
List of the category identifiers of the content.
ContentRating
integer
Rating of the content. Present only if the content supports rating and rating is filled.
ContentCreatedFrom
string
Created from 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…
ContentBodyFormatted
object
Text and HTML formatted versions of the content body.
2 properties
ContentCapabilitiesSupported
array
Types of structured messages that can be used to reply to this type of message.
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…
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…
ContentSourceType
string
Type of the channel.
ContentSynchronizationError
string
Synchronization error details.
SocMsgCreationTime
string
Creation time of the resource.
ContentPublic
boolean
True if the content is publicly visible on the remote channel (default). Private content is NOT supported on every channel.
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…
SocMsgEmailAddress
string
Email address.
CreateContentRequest
object
15 properties
ContentAttachmentIds
array
An array containing the attachment identifiers that need to be attached to the content.
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…
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.…
SocMsgPhoneNumber
string
Phone number.
ContentList
object
2 properties2 required
ContentThreadId
string
Content thread identifier of the content.
ContentCreatorId
string
RC user id of the creator
SocMsgLastModifiedTime
string
The time when the last modification was completed.
ContentContextData
object
Additional data of the content. The contextData hash keys are the custom fields keys.
ContentInReplyToAuthorIdentityId
string
The identity identifier of the content to which this content is a reply to.
ContentId
string
Identifier of the content.
ContentAttachment
object
9 properties
ContentPublished
boolean
True if the content is published on the remote channel.
ContentSourceUri
string
External Uri of the content channel.
ContentSynchronizationStatus
string
Synchronization status.
ContentSourceId
string
Identifier of the channel. On creation if inReplyToContentId is specified, the channel will be determined from it. Otherwise, this parameter is mandatory.
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…
ContentBodyInputFormat
string
Values can be Text or Html.
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property1 required
ContentStatus
string
Content status.
ContentInterventionId
string
The intervention identifier 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…
ContentStatuses
array
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
