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

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

NotificationInfo
object
Information on a notification
5 properties
InstantMessageEventBody
object
Notification payload body
16 properties
InstantMessageEvent
object
5 properties
MessageChanges
object
4 properties
MultipartRequestEntryBase
object
1 property
GetMessageMultiResponse
array
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…
MessagingNavigationInfoURI
object
Canonical URI for the corresponding page of the list
1 property
PatchMessageRequest
object
Either readStatus or availability or both are required
2 properties
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
MessageStoreCallerInfoResponseFrom
object
Sender information
5 properties
SenderInfo
object
Extension Type. For GCM transport type 'from' property should be used || Message sender information
4 properties
MessageDirectionEnum
string
Text message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound
MessageStoreConfiguration
object
1 property
GetMessageInfoMultiResponse
PatchMessageBulkRequest
array
MessageEvent
object
5 properties
MessageTypeEnum
string
Type of the message
SyncTypeEnum
string
Type of message synchronization request: - FSync -- full sync - ISync -- incremental sync
MessageAttachmentTypeEnum
string
Type of message attachment
MessagingNavigationInfo
object
Information on navigation
4 properties
GetMessageSyncResponse
object
3 properties 2 required
NotificationRecipientInfo
object
5 properties
VoicemailMessageEventBody
object
Notification payload body
14 properties
InboundMessageEvent
object
6 properties
MultipartResponseEntryBase
object
2 properties 2 required
SyncInfoMessages
object
Sync type, token and time
4 properties
MessageEventBody
object
Notification payload body
4 properties
MessagePriorityEnum
string
Message priority
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
MessageAttachmentInfo
object
9 properties
VoicemailMessageEvent
object
6 properties
UpdateMessageRequest
object
1 property 1 required
AlertInfo
object
Alert information
2 properties
GetMessageList
object
4 properties 3 required
MessageStoreCallerInfoResponseTo
object
9 properties
UpdateMessageBulkRequest
array
MessageReadStatusEnum
string
Message read status
FaxErrorCodeEnum
string
GetMessageInfoResponse
object
26 properties
ConversationInfo
object
SMS and Pager only. Information about a conversation the message belongs to
2 properties
MessagingPagingInfo
object
Information on paging
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-message-store-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 Message Store 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.