v1

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

Message Store

Sync Messages

Synchronizes messages.

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

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

extensionIdstring required

Internal identifier of the RingCentral extension/user (can be set to "~" to indicate that the extension associated with current authorization session should be used)

Query parameters

conversationIdinteger

Conversation identifier for the resulting messages. Meaningful for SMS and Pager messages only.

dateFromstring date-time

The start date/time for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is dateTo minus 24 hours

dateTostring date-time

The end date/time for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time

directionMessageDirectionEnum[]

Direction for the resulting messages. If not specified, both inbound and outbound messages are returned. Multiple values are accepted

distinctConversationsboolean

If true, then the latest messages per every conversation ID are returned

messageTypeMessageTypeEnum[]

Type for the resulting messages. If not specified, all types of messages are returned. Multiple values are accepted

recordCountinteger

Limits the number of records to be returned (works in combination with dateFrom and dateTo if specified)

syncTokenstring

A syncToken value from the previous sync response (for ISync mode only, mandatory)

syncType'FSync' | 'ISync'

Type of message synchronization request:

FSync -- full sync
ISync -- incremental sync

Type of message synchronization

voicemailOwnerstring[]

This query parameter will filter voicemail messages based on its owner. This parameter should be controlled by the 'SharedVoicemail' feature. If the feature is disabled this filter shouldn't be applied.

Response

Success

uristring uri

Link to the message sync resource

Example response

{
  "records": [
    {
      "id": 1724099032020
    }
  ]
}