Package com.ringcentral.paths.restapi.account.extension.messagestore

Class Index

java.lang.Object
com.ringcentral.paths.restapi.account.extension.messagestore.Index
public class Index extends Object

  • Field Details

  • Constructor Details

    • Index

      public Index(Index parent, String messageId)

  • Method Details

    • path

      public String path(Boolean withParameter)

    • path

      public String path()

    • list

      public GetMessageList list(ListMessagesParameters queryParams) throws RestException, IOException
      Returns a list of messages from an extension mailbox. HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store Rate Limit Group: Light App Permission: ReadMessages User Permission: ReadMessages
      Throws:
      RestException
      IOException

    • list

      public GetMessageList list() throws RestException, IOException
      Throws:
      RestException
      IOException

    • deleteAll

      public String deleteAll(DeleteMessageByFilterParameters queryParams) throws RestException, IOException
      Deletes conversation(s) by conversation ID(s). Batch request is supported, max number of IDs passed as query/path parameters is 50. Alternative syntax is supported - user conversations can be deleted by passing multiple IDs in request body as an array of string, max number of conversation IDs passed in request body is 100. In this case asterisk is used in the path instead of IDs

      HTTP Method: delete Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store Rate Limit Group: Medium App Permission: EditMessages User Permission: EditMessages

      Throws:
      RestException
      IOException

    • deleteAll

      public String deleteAll() throws RestException, IOException
      Throws:
      RestException
      IOException

    • get

      public GetMessageInfoResponse get() throws RestException, IOException
      Returns an individual message record or multiple records by the given message ID(s). The length of inbound messages is unlimited. Bulk syntax is supported.

      HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId} Rate Limit Group: Light App Permission: ReadMessages User Permission: ReadMessages

      Throws:
      RestException
      IOException

    • put

      public GetMessageInfoResponse put(UpdateMessageRequest updateMessageRequest) throws RestException, IOException
      Updates message(s) by their ID(s). Currently only message read status can be updated through this method.

      Bulk syntax is supported, max number of IDs passed as query/path parameters is 50. Alternative bulk syntax is also supported - user messages can be updated by passing multiple IDs in request body as an array of string, max number of IDs passed in the body is 1000. In this case asterisk is used in the path instead of IDs.

      HTTP Method: put Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId} Rate Limit Group: Medium App Permission: EditMessages User Permission: EditMessages

      Throws:
      RestException
      IOException

    • delete

      public String delete(String[] deleteMessageBulkRequest, DeleteMessageParameters queryParams) throws RestException, IOException
      Deletes message(s) by the given message ID(s). The first call of this method transfers the message to the 'Delete' status. The second call transfers the deleted message to the 'Purged' status. If it is required to make the message 'Purged' immediately (from the first call), then set the query parameter purge to `true`.

      HTTP Method: delete Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId} Rate Limit Group: Medium App Permission: EditMessages User Permission: EditMessages

      Throws:
      RestException
      IOException

    • delete

      public String delete(String[] deleteMessageBulkRequest) throws RestException, IOException
      Throws:
      RestException
      IOException

    • patch

      public GetMessageInfoResponse patch(PatchMessageRequest patchMessageRequest) throws RestException, IOException
      Patches message(s) by ID(s). Currently only message read status update 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.

      HTTP Method: patch Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId} Rate Limit Group: Medium App Permission: EditMessages User Permission: EditMessages

      Throws:
      RestException
      IOException

    • content

      public Index content()

    • content

      public Index content(String attachmentId)