v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB

Contents

Create Content

Creates new content for use in discussions.

This request is used to reply to already-posted content or to initiate a discussion. If authorized, the authenticated user will be used as the content author.

Content will be created and pushed asynchronously to the channel. When the content is successfully pushed to the channel, the Content.Exported event will be reported.

The account context of this request is determined by the RC Account Id associated with the access token provided in the Authorization header.

Replying to customer content is usually possible unless the channel or conversation is read only. Composing content, on the contrary, depends on the channel itself.

The channel may not support it (and be purely reactive like Instagram, Messenger, etc.).
Some channels (usually public accounts like Twitter or Facebook pages) allow for the publishing of content without targeting specific individuals.
Some channels (usually non-public media) require specific targeting (phone number for SMS, email address for email, customer_id, etc.) to be able to create content. This is channel-specific and detailed under the generic parameters.

post/cx/social-messaging/v1/contents

Request body

authorIdentityIdstring

Identity identifier of the author of content.

Not mandatory on creation, by default it uses the token's user first identity on channel.

bodystring

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 different channels supported. Channel and max length

Apple Messages For Business (max length 10000)
Email (max length 262144)
RingCX Digital Messaging (max length 1024)
Facebook (max length 8000)
GoogleBusinessMessages (max length 3000)
Google My Business (max length 4000)
Instagram (max length 950)
Instagram Messaging (max length 1000)
LinkedIn (max length 3000)
Messenger (max length 2000)
Twitter (max length 280)
Viber (max length 7000)
WhatsApp (max length 3800)
Youtube (max length 8000)

inReplyToContentIdstring

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 initiate discussion this parameter is mandatory.

publicboolean

True if the content is publicly visible on the remote channel (default).

Private content is NOT supported on every channel.

sourceIdstring

Identifier of the channel.

On creation if inReplyToContentId is specified, the channel will be determined from it. Otherwise, this parameter is mandatory.

attachmentIdsAttachmentId[]

An array containing the attachment identifiers that need to be attached to the content.

titlestring

Applicable to Email channels only.

The subject of the email.

This field is mandatory when initiating a discussion.

ccSocMsgEmailAddress[]

Applicable on Email channels only.

An array containing the email addresses used in sections of the email.

This parameter is mandatory when initiating a discussion.

bccSocMsgEmailAddress[]

Applicable on Email channels only.

An array containing the email addresses used in sections of the email.

This parameter is mandatory when initiating a discussion.

templateNamestring

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 Manager interface.

templateLanguagestring

Applicable to WhatsApp channels only.

Language of the Whatsapp template to use for the content. All available template languages are visible on the Whatsapp Business Manager interface.

Language specified must conform to the ISO 639-1 alpha-2 codes for representing the names of languages.

contextDataContentContextData

Additional data of the content.

The contextData hash keys are the custom fields keys.

autoSubmittedboolean

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 survey, etc,
doesn't get included in statistics

Example request

{
  "authorIdentityId": "541014e17aa58d8ccf000023",
  "body": "Body of the content",
  "inReplyToContentId": "123414e17asdd8ccf000023",
  "sourceId": "fff415437asdd8ccf000023",
  "attachmentIds": [
    "541014e17aa58d8ccf000023",
    "541014e17aa58d8ccf000023"
  ],
  "title": "An email title",
  "to": [
    "+33634231224"
  ],
  "cc": [
    "user@example.com"
  ],
  "bcc": [
    "user@example.com"
  ],
  "templateName": "customer_order_shipment_template",
  "templateLanguage": "fr",
  "components": [
    {
      "Message1": [
        {
          "param11": {
            "type": "Name",
            "text": "John"
          }
        },
        {
          "param12": {
            "type": "Message",
            "text": "Product rocks!"
          }
        }
      ]
    },
    {
      "Message2": [
        {
          "param21": {
            "type": "Agent Name",
            "text": "Alice"
          }
        },
        {
          "param22": {
            "type": "Message",
            "text": "Thank you"
          }
        }
      ]
    }
  ],
  "contextData": {
    "test1": "value1",
    "test2": "value2"
  }
}

Response

Successful response.

authorIdentityIdstring required

Identity identifier of the author of content.

Not mandatory on creation, by default it uses the token's user first identity on channel.

autoSubmittedboolean required

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 survey, etc,
doesn't get included in statistics

bodystring required

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 different channels supported. Channel and max length

Apple Messages For Business (max length 10000)
Email (max length 262144)
RingCX Digital Messaging (max length 1024)
Facebook (max length 8000)
GoogleBusinessMessages (max length 3000)
Google My Business (max length 4000)
Instagram (max length 950)
Instagram Messaging (max length 1000)
LinkedIn (max length 3000)
Messenger (max length 2000)
Twitter (max length 280)
Viber (max length 7000)
WhatsApp (max length 3800)
Youtube (max length 8000)

bodyInputFormat'Text' | 'Html' required

Values can be Text or Html.

categoryIdsstring[] required

List of the category identifiers of the content.

contextDataContentContextData

Additional data of the content.

The contextData hash keys are the custom fields keys.

creationTimestring date-time required

Creation time of the resource.

Created from of the content.

creatorIdstring required

RC user id of the creator

foreignCategoriesstring[]

External categories of the content.

Present only if the content has foreignCategories.

idstring required

Identifier of the content.

inReplyToAuthorIdentityIdstring required

The identity identifier of the content to which this content is a reply to.

inReplyToContentIdstring required

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 initiate discussion this parameter is mandatory.

interventionIdstring required

The intervention identifier of the content.

languagestring required

Language of the content.

publicboolean required

True if the content is publicly visible on the remote channel (default).

Private content is NOT supported on every channel.

publishedboolean required

True if the content is published on the remote channel.

ratinginteger required

Rating of the content.

Present only if the content supports rating and rating is filled.

remotelyDeletedboolean required

True if the content has been deleted on the remote channel.

sourceIdstring required

Identifier of the channel.

On creation if inReplyToContentId is specified, the channel will be determined from it. Otherwise, this parameter is mandatory.

Type of the channel.

sourceUristring uri required

External Uri of the content channel.

Content status.

synchronizationStatusstring required

Synchronization status.

synchronizationErrorstring required

Synchronization error details.

threadIdstring required

Content thread identifier of the content.

titlestring required

Applicable to Email channels only.

The subject of the email.

This field is mandatory when initiating a discussion.

Type of the content.

lastModifiedTimestring date-time required

The time when the last modification was completed.

capabilitiesSupportedstring[] required

Types of structured messages that can be used to reply to this type of message.

Example response

{
  "attachments": [
    {
      "contentType": "image/jpeg",
      "creationTime": "2023-02-04T12:43:07Z",
      "filename": "0.jpeg",
      "id": "54085e5b7aa58d8b5d00006c",
      "size": 217571,
      "lastModifiedTime": "2023-02-04T12:43:07Z",
      "uri": "https://example.digital.ringcentral.com/files/attachments/54085e5b7aa58d8b5d00006c"
    }
  ],
  "authorIdentityId": "541014e17aa58d8ccf000023",
  "body": "Body of the content",
  "categoryIds": [
    "541014e17aa58d8ccf000023",
    "541014e17aa58d8ccf002023"
  ],
  "contextData": {
    "test1": "value1",
    "test2": "value2"
  },
  "creationTime": "2023-02-04T12:43:07Z",
  "creatorId": "2683222036",
  "foreignCategories": [
    "foreign_category_id"
  ],
  "id": "541014e17aa58d8ccf000023",
  "inReplyToAuthorIdentityId": "541014e17asdd8ccf000023",
  "inReplyToContentId": "123414e17asdd8ccf000023",
  "interventionId": "123415437asdd8ccf000023",
  "language": "En",
  "published": true,
  "rating": 4,
  "sourceId": "fff415437asdd8ccf000023",
  "synchronizationStatus": "success",
  "title": "An email title",
  "type": "Email",
  "lastModifiedTime": "2023-02-04T12:43:07Z"
}