Retrieve Message Progress Node

The “Retrieve Message Progress” node retrieves the processing progress of an asynchronous message. One typically uses asynchronous messaging when the content you want to send or log is above 10MB since such large files require message chunking. It takes as input the ID of an ephemeral message (either a provisional or a cached message) and returns a JSON object containing the action that was performed on the message (sent, log, read), how many bytes of the message were processed thus far, whether the processing has been finalized, an error code if one occurred, etc.

Image of the Retrieve Message Progress Node

Node Properties Panel Field Description

Node property configuration slide-out panel (this panel is accessed by double-clicking on the node).

Retrieve Message Progress Properties

Node-RED Specific Fields

  1. Name Field:  Add a descriptive name of your choice that will help differentiate this node from others of the same type on the Node-RED workspace (not required).
  2. Connection Field: This drop-down selection is required.  Set a previously configured Catenis connection (virtual device). If you need to configure a new virtual device click the pencil button to the right of the field and follow the direction on setting up a new virtual device that can be found here.

How to use

  1. Drag and drop this node from the Catenis Flow pallet area to the Node-RED workspace. Double-click it to display its properties slide out panel.
  2. On the “Device” drop-down field of the properties slide out panel, choose the Catenis virtual device you previously configured. The virtual device is a configuration node containing the Catenis Virtual device information (device ID and API Secret key). If you do not have a virtual device configured see section titled: “Configure your first virtual device on Node-RED” 
  3. Add the node’s configuration information based on your needs to each field of the properties slide out panel.  Please refer to the description of each field under the section named “Node Properties Panel Field Description” on proper usage.
  4. Wire this node to a debug node. 
  5. Next, drag and drop an “inject” node to the Node-RED workspace.
  6. Wire the “inject” node to the “Retrieve Message Progress” node, then double click the “inject” node to open its properties slide out panel. 
  7. Alter the information in the “inject” node’s properties slide out panel by selecting the drop-down “Payload” field and choose the “String” Type.
  8. Enter the message ID you wish to pass as input to the Catenis Node (an example String input is below). This must be the Id of an asynchronous message. After entering your message ID entry click the red Done button. Then click the Done button again to exit the properties dialogue box.
  9. Click the red Deploy button on the upper right hand side of the Node-RED dashboard to deploy this flow.
  10. Now let’s test the flow: Click the button on the left attached to the “inject” node to send the input from the “inject” node to the flow.
  11. The debug sidebar should display the returned JSON object containing the API call results to the right side of the workspace.

Example of String that can be passed to this node


Note: This node cannot take a JSON objects as input.

Example Flow - Import Into Node-Red to Get Started

[{"id":"b744d248.60625","type":"retrieve message progress","z":"d00c0be5.1ab778","name":"","device":"","x":540,"y":200,"wires":[["d43c0f65.818e6"]]},{"id":"d1d20b6d.63f088","type":"inject","z":"d00c0be5.1ab778","name":"inject","topic":"","payload":"Enter Your Medssage ID of an asynchronous message","payloadType":"str","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":210,"y":200,"wires":[["b744d248.60625"]]},{"id":"d43c0f65.818e6","type":"debug","z":"d00c0be5.1ab778","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","x":898,"y":200,"wires":[]},{"id":"e08df1ca.e7601","type":"comment","z":"d00c0be5.1ab778","name":"Double click for instructions","info":"Enter the message ID of your asynchronous message here.","x":170,"y":140,"wires":[]},{"id":"b8353b19.518a68","type":"comment","z":"d00c0be5.1ab778","name":"Set virtual device for this Catenis node","info":"All Catenis nodes require that you set the proper virtual device on its slideout property panel on the device field.\n\nNot setting the device properly will result in a \"TypeError: Cannot read property 'ctnApiClient' of null\" ","x":550,"y":160,"wires":[]}]

Note: After importing this flow you will need to set the “retrieve message progress” node in this flow to use a previously configured virtual devices. You will also need to set the message ID (the payload in the inject node) to the id of a message you have previously logged.

Related Articles

How can we make things Better for you?
  • Accepted file types: jpg, gif, png, pdf.
  • This field is for validation purposes and should be left unchanged.