A tutorial to teach you how to download message attachments from user's message store. Click the "Start" button below to start the tutorial.
Start TutorialClone the project from GitHub and install RingCentral Node JS SDK and dependencies.
If you don't know how to create a RingCentral app. Click https://developer.ringcentral.com/library/getting-started.html for instructions.
Copy the Client id and Client secret and add them to the environment/.env-sandbox file.
RC_CLIENT_ID=
RC_CLIENT_SECRET=
Add the account login credentials to the environment/.env-sandbox file.
RC_USERNAME=
RC_PASSWORD=
RC_EXTENSION=
If you want to specify variables for your production environment, repeat this step for the environment/.env-production file.
Using a RingCentral SDK is the most convenient way to authenticate and access RingCentral platform services.
After login successfully, we call the function read_message_store_message_content() to read and download the content.
We call the "message-store" endpoint and specify the time period using the dateFrom and dateTo query parameters.
You can specify other query parameters such as messageType, direction etc. if you want.
We parse the JSON response and get the amount of items from the records array.
We also create a "content" folder to store message attachments.
To get ready for downloading a big amount of messages attachment, we limit API call to ~40 calls per minute to avoid exceeding API rate limit. For that purpose, we use the index variable to iterate through the records array within the setInterval timer function.
Each record may contain several attachments. We iterate through the attachments array, detect the message type to create a file name and file name extension accordingly.
We implement the getFileExtensionFromMimeType() function to specify the filename extension based on the attachment contentType.
We download the attachment by calling the platform.get() function to get the content from the attachment.uri.
Finally, we read the data buffer then save the data to a file under the content folder.
We increase the index each time after we read a record. If we read all the records from the records array, we clear the timer and finish the download process, otherwise, we wait for about 1.2 seconds then download the next attachment.