v1

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

List Messages

Returns a list of messages from an extension mailbox.

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

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

availabilityMessageAvailabilityEnum[]

Specifies the availability status for resulting messages. Multiple values are accepted

conversationIdstring

Specifies a conversation identifier for the resulting messages

dateFromstring date-time

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

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 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 of resulting messages. If not specified, all messages without message type filtering are returned. Multiple values are accepted

readStatusMessageReadStatusEnum[]

Read status for resulting messages. Multiple values are accepted

pageinteger

Indicates a page number to retrieve. Only positive number values are accepted

perPageinteger

Indicates a page size (number of items)

phoneNumberstring

Phone number. If specified, messages are returned for this particular phone number only

Response

Message list

uristring uri

Link to a list of user messages

Example response

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