RIringcentral
Message Exports

Create Message Store Report

Creates a task to collect all account messages within the specified time interval. Maximum number of simultaneous tasks per account is 2.

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

Request

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)

Request body

dateTostring date-time

The end of the time range to collect message records in ISO 8601 format including timezone. Default is the current time

dateFromstring date-time

The beginning of the time range to collect call log records in ISO 8601 format including timezone. Default is the current time minus 24 hours

messageTypesPicMessageTypeEnum[]

Types of messages to be collected. If not specified, all messages without message type filtering will be returned. Multiple values are accepted

Example request

{
  "messageTypes": [
    "Fax",
    "VoiceMail"
  ]
}

Response

Success

idstring

Internal identifier of a message store report task

uristring uri

Canonical URI of a task

status'Accepted' | 'Pending' | 'InProgress' | 'AttemptFailed' | 'Failed' | 'Completed' | 'Cancelled'

Status of a message store report task

accountIdstring

Internal identifier of an account

extensionIdstring

Internal identifier of an extension

dateTostring date-time

The end of the time range to collect message records in ISO 8601 format including timezone

dateFromstring date-time

The beginning of the time range to collect call log records in ISO 8601 format including timezone

startTimestring date-time

The time when this task was started

finishTimestring date-time

The time when this task was finished

messageTypesPicMessageTypeEnum[]

Type of messages to be collected.

Example response

{
  "id": "400142200026-400142200026-bd162f24028442489385eb3f44c18354",
  "messageTypes": [
    "Fax",
    "VoiceMail"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.