RingCentral Message Store API

The Message Store API from RingCentral — 5 operation(s) for message store.

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

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

This API exposes 10 operations across 5 paths, and defines 43 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.

10 operations 5 paths 43 schemas 2 DELETE5 GET1 PATCH2 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

Contact

RingCentral Developers Support

License

RingCentral API License Agreement

View terms

Resource Areas

Authentication & Security 1

RingCentral Message Store 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 10

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

Message Store 10

GET

/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{attachmentId}

Get Message Attachment Content

readMessageContent 6 params → 200

GET

/restapi/v1.0/account/{accountId}/message-store-configuration

Get Message Store Configuration

readMessageStoreConfiguration 1 param → 200

PUT

/restapi/v1.0/account/{accountId}/message-store-configuration

Update Message Store Configuration

updateMessageStoreConfiguration 1 param body → 200

GET

/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-sync

Sync Messages

syncMessages 12 params → 200

GET

/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store

List Messages

listMessages 13 params → 200

DELETE

/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store

Delete Conversation

deleteMessageByFilter 5 params → 204

GET

/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}

Get Message(s)

readMessage 3 params → 200207

PUT

/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}

Update Message(s)

updateMessage 3 params body → 200207

PATCH

/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}

Patch Message(s)

patchMessage 3 params body → 200207

DELETE

/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}

Delete Message

deleteMessage 4 params body → 204

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are GetMessageInfoResponse (26 properties), InstantMessageEventBody (16 properties), VoicemailMessageEventBody (14 properties), MessageAttachmentInfo (9 properties). Each schema is shown below with its type and property counts.

MessageDirectionEnum

string

Text message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound

MessageEventBody

object

Notification payload body

4 properties

MultipartRequestEntryBase

object

1 property

MessageAttachmentTypeEnum

string

Type of message attachment

MessagingNavigationInfo

object

Information on navigation

4 properties

NotificationRecipientInfo

object

5 properties

SyncTypeEnum

string

Type of message synchronization request: - FSync -- full sync - ISync -- incremental sync

ConversationInfo

object

SMS and Pager only. Information about a conversation the message belongs to

2 properties

InstantMessageEventBody

object

Notification payload body

16 properties

MessageChanges

object

4 properties

PatchMessageBulkRequest

array

GetMessageSyncResponse

object

3 properties 2 required

MessageStoreCallerInfoResponseFrom

object

Sender information

5 properties

InstantMessageEvent

object

5 properties

UpdateMessageBulkRequest

array

AlertInfo

object

Alert information

2 properties

SenderInfo

object

Extension Type. For GCM transport type 'from' property should be used || Message sender information

4 properties

MessagingNavigationInfoURI

object

Canonical URI for the corresponding page of the list

1 property

MultipartResponseEntryBase

object

2 properties 2 required

MessageStoreConfiguration

object

1 property

VoicemailMessageEvent

object

6 properties

MessageEvent

object

5 properties

GetMessageInfoResponse

object

26 properties

MessagingPagingInfo

object

Information on paging

6 properties

MessageTypeEnum

string

Type of the message

PatchMessageRequest

object

Either readStatus or availability or both are required

2 properties

MessageAttachmentInfo

object

9 properties

GetMessageMultiResponse

array

GetMessageList

object

4 properties 3 required

NotificationInfo

object

Information on a notification

5 properties

MessageAvailabilityEnum

string

Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments ar…

DeleteMessageBulkRequest

array

MessageStoreCallerInfoResponseTo

object

9 properties

VoicemailMessageEventBody

object

Notification payload body

14 properties

MessageStatusEnum

string

Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned. If, for outboun…

MessagePriorityEnum

string

Message priority

SyncInfoMessages

object

Sync type, token and time

4 properties

InboundMessageEvent

object

6 properties

FaxErrorCodeEnum

string

GetMessageInfoMultiResponse

MessageReadStatusEnum

string

Message read status

UpdateMessageRequest

object

1 property 1 required

FaxResolutionEnum

string

Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs RingCentral publishes across the network.

RingCentral SMS API

AE Profile APIs.io

RingCentral Team Messaging API

AE Profile APIs.io

RingCentral Video API

AE Profile APIs.io

RingCentral Fax API

AE Profile APIs.io

RingCentral Data API

AE Profile APIs.io

RingCentral Audio and Video AI API

AE Profile APIs.io

RingCentral Call Log API

AE Profile APIs.io

RingCentral Call Analytics API

AE Profile APIs.io

RingCentral Presence API

AE Profile APIs.io

RingCentral Voicemail API

AE Profile APIs.io

RingCentral Provisioning API

AE Profile APIs.io

RingCentral Webhooks and Subscriptions API

AE Profile APIs.io

#Message Store

← Back to R APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

RingCentral Message Store API

Metadata

Authentication & Security 1

Paths & Operations 10

Schemas 43

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

RingCentral Message Store API

Metadata

Authentication & Security 1

Paths & Operations 10

Schemas 43

Specification

Source

More from RingCentral 12

API Details

Provider

Explore more