v1

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

Message Store

Patch Message(s)

Patches message(s) by ID(s). Currently, only updating the readStatus and restoring deleted messages are supported through this method.

For changing status of a message send readStatus set to either 'Read' or 'Unread' in request. It is possible to restore a message and its attachments (if message status is 'Deleted') by sending availability attribute set to 'Alive' in request body. If a message is already in 'Purged' state then its attachments cannot be restored and the message itself is about to be physically deleted.

Bulk syntax (both traditional and alternative one) is supported.

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

Request body

readStatus'Read' | 'Unread'

Message read status

availability'Alive' | 'Deleted' | 'Purged'

Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly

Response

Successful response (single message)

idinteger

Internal identifier of a message

uristring uri

Canonical URI of a message

extensionIdstring

Internal identifier of an extension

availability'Alive' | 'Deleted' | 'Purged'

conversationIdinteger

SMS and Pager only. Identifier of a conversation the message belongs to

creationTimestring date-time

Message creation date/time in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z

deliveryErrorCodestring

SMS only. Delivery error code returned by gateway

direction'Inbound' | 'Outbound'

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

faxPageCountinteger

Fax only. Page count in a fax message

faxResolution'High' | 'Low'

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

lastModifiedTimestring date-time

The date/time when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z

Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned. If, for outbound message, a status for at least one recipient is 'Queued', then the 'Queued' value is returned. If a status for at least one recipient is 'SendingFailed', then the 'SendingFailed' value is returned. In other cases the 'Sent' status is returned

pgToDepartmentboolean

Pager only. true if at least one of the message recipients is 'Department' extension

priority'Normal' | 'High'

Message priority

readStatus'Read' | 'Unread'

Message read status

smsDeliveryTimestring date-time

SMS only. Date/time when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if a carrier sends a delivery receipt to RingCentral

smsSendingAttemptsCountinteger

SMS only. Number of attempts made to send an outbound SMS to the Gateway (if Gateway is temporary unavailable)

subjectstring

Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment

type'Fax' | 'SMS' | 'VoiceMail' | 'Pager' | 'Text'

Message type

Voicemail only. Status of a voicemail to text transcription. If 'VoicemailToText' feature is not activated for account, the 'NotAvailable' value is returned

coverIndexinteger

Cover page identifier. If coverIndex is set to '0' (zero) cover page is not attached. For the list of available cover page identifiers (1-13) please call the Fax Cover Pages method. If not specified, the default cover page is attached (which is configured in 'Outbound Fax Settings')

coverPageTextstring

Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols

Example response

{
  "id": 1724099032020
}