GetMessages

Return the content of the specified messages (if found).

Service	Operation
messaging	GET_MESSAGES

Method Parameters

Parameter	Description
msgbox	The messagebox that the messages reside in
msgids	An array of message ids
markAsRead	Whether the messages should be marked as read once retrieved.

Usage

http://localhost:3000

C#

string msgbox = "inbox";
string[] msgIds = { "msgId1", "msgId2" };
bool markAsRead = false;
SuccessCallback successCallback = (response, cbObject) =>
{
    Debug.Log(string.Format("Success | {0}", response));
};
FailureCallback failureCallback = (status, code, error, cbObject) =>
{
    Debug.Log(string.Format("Failed | {0}  {1}  {2}", status, code, error));
};

_bc.MessagingService.GetMessages(msgbox, msgIds, markAsRead, successCallback, failureCallback);

C++

const char *msgbox = "inbox";
std::vector<std::string> msgIds;
msgIds.push_back("msgId1");
msgIds.push_back("msgId2");
bool markAsRead = false;
_bc->getMessagingService()->getMessages(msgbox, msgIds, markAsRead, this);

Objective-C

NSString *msgbox = @"inbox";
NSArray *msgIds = @[ @"msgId1", @"msgId2" ];
bool markAsRead = false;
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc messagingService] getMessages:msgbox
                     msgIds:msgIds
                 markAsRead:markAsRead
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String msgbox = "inbox";
String[] msgIds = { "msgId1", "msgId2" };
boolean markAsRead = false;
this; // implements IServerCallback

_bc.getMessagingService().getMessages(msgbox, msgIds, markAsRead, this);

public void serverCallback(ServiceName serviceName, ServiceOperation serviceOperation, JSONObject jsonData)
{
    System.out.print(String.format("Success | %s", jsonData.toString()));
}
public void serverError(ServiceName serviceName, ServiceOperation serviceOperation, int statusCode, int reasonCode, String jsonError)
{
    System.out.print(String.format("Failed | %d %d %s", statusCode,  reasonCode, jsonError.toString()));
}

JavaScript

var msgbox = "inbox";
var msgIds = [ "msgId1", "msgId2" ];
var markAsRead = false;

_bc.messaging.getMessages(msgbox, msgIds, markAsRead, result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

var  msgBox = "inbox";
var  msgIds = [ "msgId1", "msgId2" ];
var  markAsRead = false;

ServerResponse result = await _bc.messagingService.getMessages(msgBox:msgBox, msgIds:msgIds, markAsRead:markAsRead);

if (result.statusCode == 200) {
    print("Success");
} else {
    print("Failed ${result.error['status_message'] ?? result.error}");
}

Cloud Code

var msgbox = "inbox";
var msgIds = [ "msgId1", "msgId2" ];
var markAsRead = false;
var messagingProxy = bridge.getMessagingServiceProxy();

var postResult = messagingProxy.getMessages(msgbox, msgIds, markAsRead);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "messaging",
    "operation": "GET_MESSAGES",
    "data": {
        "msgbox": "inbox",
        "msgIds": [
            "msgId1",
            "msgId2"
        ],
        "markAsRead": false
    }
}

JSON Response

{
    "status": 200,
    "data": {
        "requested": 2,
        "actual": 2,
        "items": [
            {
                "msgbox": "inbox",
                "msgId": "0b102b77-5478-4bf4-b212-1b26d03d2dd6",
                "mbVer": 1,
                "mbCr": 1530289175397,
                "mbUp": 1530289175397,
                "read": false,
                "message": {
                    "from": {
                        "id": "c3a455de-27f5-4126-a051-0effb1c75fd3",
                        "name": ""
                    },
                    "to": ["c3a455de-27f5-4126-a051-0effb1c75fd3"],
                    "sentAt": 1530289175381,
                    "content": {
                        "subject": "Message 1",
                        "text": "Message 1"
                    }
                }
            },
            {
                "msgbox": "inbox",
                "msgId": "5a11e6e3-7bbd-46ef-85ec-797d22eb3486",
                "mbVer": 1,
                "mbCr": 1530289180524,
                "mbUp": 1530289180524,
                "read": false,
                "message": {
                    "from": {
                        "id": "c3a455de-27f5-4126-a051-0effb1c75fd3",
                        "name": ""
                    },
                    "to": ["c3a455de-27f5-4126-a051-0effb1c75fd3"],
                    "sentAt": 1530289180520,
                    "content": {
                        "subject": "Message 2",
                        "text": "Message 2"
                    }
                }
            }
        ]
    }
}

Common Error Code

Status Codes

Code	Name	Description
40601	FEATURE_NOT_ENABLED	Messaging feature is not enabled for app.