(Node.js) SQS Receive Message

Retrieves one or more messages from an Amazon SQS queue, with a maximum limit of 10 messages, from the specified queue.

See SQS ReceiveMessage or detailed information.

Install Chilkat for Node.js and Electron using npm at

Chilkat npm packages for Node.js
Chilkat npm packages for Electron
on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var rest = new chilkat.Rest();

    // Connect to the Amazon AWS REST server.
    // such as https://sqs.us-west-2.amazonaws.com/
    var bTls = true;
    var port = 443;
    var bAutoReconnect = true;
    var success = rest.Connect("sqs.us-west-2.amazonaws.com",port,bTls,bAutoReconnect);

    // Provide AWS credentials for the REST call.
    var authAws = new chilkat.AuthAws();
    authAws.AccessKey = "AWS_ACCESS_KEY";
    authAws.SecretKey = "AWS_SECRET_KEY";
    // the region should match our URL above..
    authAws.Region = "us-west-2";
    authAws.ServiceName = "sqs";

    rest.SetAuthAws(authAws);

    rest.AddQueryParam("Action","ReceiveMessage");
    rest.AddQueryParam("MaxNumberOfMessages","5");
    rest.AddQueryParam("VisibilityTimeout","15");
    rest.AddQueryParam("AttributeName","All");
    rest.AddQueryParam("MessageAttributeName","All");

    // Use the actual path part of your SQS queue URL here:
    var responseXml = rest.FullRequestNoBody("GET","/123456789123/chilkatTest");
    if (rest.LastMethodSuccess !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    // A successful response will have a status code equal to 200.
    if (rest.ResponseStatusCode !== 200) {
        console.log("response status code = " + rest.ResponseStatusCode);
        console.log("response status text = " + rest.ResponseStatusText);
        console.log("response header: " + rest.ResponseHeader);
        console.log("response body: " + responseXml);
        return;
    }

    // Examine the successful XML response.
    var xml = new chilkat.Xml();
    xml.LoadXml(responseXml);
    console.log(xml.GetXml());
    console.log("----");

    // A successful response looks like this:
    // <?xml version="1.0" encoding="utf-8" ?>
    // <ReceiveMessageResponse xmlns="http://queue.amazonaws.com/doc/2012-11-05/">
    //     <ReceiveMessageResult>
    //         <Message>
    //             <Body>this is a test</Body>
    //             <MD5OfBody>54b0c58c7ce9f2a8b551351102ee0938</MD5OfBody>
    //             <ReceiptHandle>AQEBMyLof...UbKBTvHtEg==</ReceiptHandle>
    //             <Attribute>
    //                 <Name>SenderId</Name>
    //                 <Value>957491831129</Value>
    //             </Attribute>
    //             <Attribute>
    //                 <Name>ApproximateFirstReceiveTimestamp</Name>
    //                 <Value>1475013283557</Value>
    //             </Attribute>
    //             <Attribute>
    //                 <Name>ApproximateReceiveCount</Name>
    //                 <Value>4</Value>
    //             </Attribute>
    //             <Attribute>
    //                 <Name>SentTimestamp</Name>
    //                 <Value>1475013283557</Value>
    //             </Attribute>
    //             <MessageId>52882c65-5e21-4450-9024-93a3b01e61d3</MessageId>
    //             <MD5OfMessageAttributes>2ff68603f4239272bd03f543254ed040</MD5OfMessageAttributes>
    //         </Message>
    //     </ReceiveMessageResult>
    //     <ResponseMetadata>
    //         <RequestId>05ba5c92-80ee-5f87-be76-0cf67b7475d6</RequestId>
    //     </ResponseMetadata>
    // </ReceiveMessageResponse>

    // Get some values from the XML:
    console.log("Body: " + xml.ChilkatPath("ReceiveMessageResult|Message|Body|*"));
    console.log("MessageId: " + xml.ChilkatPath("ReceiveMessageResult|Message|MessageId|*"));

    var unused = xml.ChilkatPath("ReceiveMessageResult|Message[0]|Attribute|$");

    // rec: Xml
    var rec = xml.FindNextRecord("Name","SenderId");
    console.log("SenderId: " + rec.GetChildContent("Value"));

    rec = xml.FindNextRecord("Name","ApproximateFirstReceiveTimestamp");
    console.log("ApproximateFirstReceiveTimestamp: " + rec.GetChildContent("Value"));

    rec = xml.FindNextRecord("Name","ApproximateReceiveCount");
    console.log("ApproximateReceiveCount: " + rec.GetChildContent("Value"));

    rec = xml.FindNextRecord("Name","SentTimestamp");
    console.log("SentTimestamp: " + rec.GetChildContent("Value"));

    xml.GetRoot2();

}

chilkatExample();