HTTP POST

Sending Messages via Nuntio HTTP Interface

Nuntio provides an HTTP interface for sending messages to users through a simple POST request. This interface is ideal for integrating with external systems that need to send alerts, notifications, or dynamic messages directly to Nuntio users.

---

Endpoint

The URL for sending a message is:

[main Nuntio URL]/interface/sendv1.ashx

This endpoint accepts a POST request with a message payload, which includes the recipient's information, message content, and other required fields.

---

Required Parameters

• site: The GUID for your Nuntio site, available in the admin site.

• sitetoken: The token that authenticates your request, also available in the admin site.

• sendto: The email address of the user receiving the message (e.g., [email protected]).

• plainmessage: The text of the message to be sent.

• messagetype: (Optional) Specifies the type of message if applicable.

• apikey: Your API key, required for authorization.

• reqack: Determines if an acknowledgment is required (true or false).

---

Example 1: Simple Message

This example demonstrates sending a basic message to a user.

{
   "message": {
      "site": "site-guid", 
      "sitetoken": "site-token", 
      "sendto": "[email protected]",
      "plainmessage": "There is a patient pickup needed in room 44",
      "messagetype": "",
      "apikey": "**your api key here**",
      "reqack": "false"
   }
}

In this example:

• The message is sent to [email protected].

• The message content is: "There is a patient pickup needed in room 44."

• No acknowledgment is required (reqack: false).

---

Example 2: Message with Dynamic Data

Dynamic data can be sent along with the message, allowing you to include specific variables such as patient names or room numbers.

{
   "message": {
      "site": "site-guid", 
      "sitetoken": "site-token", 
      "sendto": "[email protected]",
      "plainmessage": "",
      "messagetype": "LAB1",
      "apikey": "**your api key here**",
      "reqack": "false"
   },
   "dynamicdata": {
      "PatientName": "Smith, Nancy",
      "Room": "44"
   }
}

In this example:

• A message with a type of LAB1 is sent to [email protected].

• Dynamic data is included, such as the patient’s name (Smith, Nancy) and room number (44).

• The message content will use these dynamic data points if configured in your system.

---

HTTP Request Details

• Method: POST

• Content-Type: application/json

• Body: JSON object containing the message and any dynamic data (if applicable).

---

Getting API Keys and Site GUID

Both the API key and Site GUID can be obtained from the Nuntio Admin Site:

1. Log in to the Admin Site at:

   [main Nuntio URL]/admin

2. Navigate to API Info to retrieve your API key and Site GUID.