Working with the Message Store
Last updated: 2020-03-30 Contributors 
The RingCentral Message Store is a centralized repository of all the messages sent and received within the system. There are many types of messages that can be stored here, including:
- SMS and MMS messages
- Faxes
- Voicemail
Messages within the Message Store can be managed in a variety of ways. One can:
- Delete messages
- Modify the read/unread status
- View the delivery status
Learn more about modifying the Message Store »
Message Data Structure
Below is an example JSON representation of a message that would be returned by the API when fetching a list or single message. This particular message is a voicemail:
{
"uri" : "https://platform.ringcentral.com/restapi/v1.0/account/4xxx8/extension/4xxx8/message-store/4xxx8",
"id" : 402406984008,
"type" : "VoiceMail",
"to" : [ {
"name" : "Jane Smith"
} ],
"from" : {
"phoneNumber" : "+18445558517",
"name" : "RingCentral"
},
"creationTime" : "2018-09-18T09:24:03.000Z",
"readStatus" : "Unread",
"priority" : "Normal",
"attachments" : [ {
"id" : 402406984008,
"uri" : "https://platform.ringcentral.com/restapi/v1.0/account/4xxx8/extension/4xxx8/message-store/4xxx8/content/4xxx8",
"type" : "AudioRecording",
"contentType" : "audio/x-wav",
"vmDuration" : 25
} ],
"direction" : "Inbound",
"availability" : "Alive",
"messageStatus" : "Received",
"lastModifiedTime" : "2018-09-18T09:24:03.531Z",
"vmTranscriptionStatus" : "NotAvailable"
}
The API Reference contains a more detailed breakdown of the structure of a message within the Message Store.
Getting a list of messages
The following code sample shows how to call the Message Store to display a list of messages within it. To read messages from the Message Store, apps will need the "Read Messages" permission.
const RC = require('ringcentral')
var rcsdk = new RC( {server: "server_url", appKey: "client_id", appSecret: "client_secret"} );
var platform = rcsdk.platform();
platform.login( {username: "username", password: "password", extension: "extension_number"} )
.then(function(resp) {
platform.get('/account/~/extension/~/message-store', {
messageType: ['SMS']
})
.then(function (response) {
console.log(JSON.stringify(response.json()))
})
});
}
from ringcentral import SDK
sdk = SDK( "client_id", "client_secret", "server_url" )
platform = sdk.platform()
platform.login( "username", "extension", "password" )
response = platform.get('/restapi/v1.0/account/~/extension/~/message-store',
{
'messageType': ['SMS']
})
print (response.text())
<?php
require('vendor/autoload.php');
$rcsdk = new RingCentral\SDK\SDK( "client_id", "client_secret", "server_url" );
$platform = $rcsdk->platform();
$platform->login( "username", "extension_number", "password" );
$response = $platform->get('/account/~/extension/~/message-store',
array(
'messageType' => array('SMS')
));
print_r ($response->text());
using System;
using Newtonsoft.Json;
using System.Threading.Tasks;
using RingCentral;
namespace Read_MessageStore
{
class Program
{
static void Main(string[] args)
{
read_user_message_store().Wait();
}
static private async Task read_user_message_store()
{
RestClient rc = new RestClient("client_id", "client_secret", "server_url");
await rc.Authorize("username", "extension_number", "password");
var parameters = new ListMessagesParameters();
parameters.messageType = string[] ("SMS");
var response = await rc.Restapi().Account().Extension().MessageStore().List(parameters);
var jsonStr = JsonConvert.SerializeObject(response);
Console.WriteLine(jsonStr);
}
}
}
import com.ringcentral.*;
import com.ringcentral.definitions.*;
public class Read_MessageStore {
public static void main(String[] args) {
try {
read_user_message_store();
} catch (RestException | IOException e) {
e.printStackTrace();
}
}
public static void read_user_message_store() throws RestException, IOException{
RestClient rc = new RestClient("client_id", "client_secret", "server_url");
rc.authorize("username", "extension_number", "password");
ListMessagesParameters parameters = new ListMessagesParameters();
parameters.messageType = new String[] {"SMS"};
var response = rc.restapi().account().extension().messagestore().list(parameters);
String jsonStr = JSON.toJSONString(response);
System.out.println(jsonStr);
}
}
require 'ringcentral'
rc = RingCentral.new( 'client_id', 'client_secret', 'server_url')
rc.authorize( username: 'username', extension: 'extension_number', password: 'password')
response = rc.get('/account/~/extension/~/message-store',
{
messageType: 'SMS'
})
puts response.body
This example response shows the to, from, type, readStatus, direction and subject amongst other properties of an SMS message record from the message store:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | |