💬 Send SMS

Install the node package using one of the following package managers:

npm install notificationapi-node-server-sdk

yarn add notificationapi-node-server-sdk

pnpm add notificationapi-node-server-sdk

pip install notificationapi_python_server_sdk

composer require notificationapi/notificationapi-php-server-sdk

go get github.com/notificationapi-com/notificationapi-go-server-sdk

dotnet add package NotificationAPI --version 0.5.0

Add the following dependency to your Maven project:

<dependency>
    <groupId>com.notificationapi</groupId>
    <artifactId>notificationapi-java-server-sdk</artifactId>
    <version>0.2.0</version>
</dependency>

For optimal functionality, you’ll also need:

<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.14</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.15.2</version>
</dependency>

Add the NotificationAPI class to your application - see the full Ruby implementation.

import notificationapi from 'notificationapi-node-server-sdk';

// Initialize (default US region)
// For CA region: add 'https://api.ca.notificationapi.com' after CLIENT_SECRET
// For EU region: add 'https://api.eu.notificationapi.com' after CLIENT_SECRET
notificationapi.init('YOUR_CLIENT_ID', 'YOUR_CLIENT_SECRET');

// Send SMS notification
notificationapi.send({
  type: 'welcome_sms',
  to: {
    id: 'user123',
    number: '+16175551212' // Required for SMS notifications (E.164 format)
  },
  parameters: {
    firstName: 'John',
    companyName: 'Acme Corp'
  }
});

import asyncio
from notificationapi_python_server_sdk import notificationapi

# Initialize (default US region)
notificationapi.init("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")

async def send_sms():
    await notificationapi.send({
        "type": "welcome_sms",
        "to": {
            "id": "user123",
            "number": "+16175551212"  # Required for SMS notifications (E.164 format)
        },
        "parameters": {
            "firstName": "John",
            "companyName": "Acme Corp"
        }
    })

# Run the async function
asyncio.run(send_sms())

use NotificationAPI\NotificationAPI;

// Initialize
$notificationapi = new NotificationAPI('YOUR_CLIENT_ID', 'YOUR_CLIENT_SECRET');

// Send SMS notification
$notificationapi->send([
    "type" => "welcome_sms",
    "to" => [
        "id" => "user123",
        "number" => "+16175551212"  // Required for SMS notifications (E.164 format)
    ],
    "parameters" => [
        "firstName" => "John",
        "companyName" => "Acme Corp"
    ]
]);

package main

import (
    notificationapi "github.com/notificationapi-com/notificationapi-go-server-sdk"
)

func main() {
    // Initialize
    notificationapi.Init("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET", "https://api.notificationapi.com")

    // Prepare parameters
    parameters := make(map[string]interface{})
    parameters["firstName"] = "John"
    parameters["companyName"] = "Acme Corp"

    // Send SMS notification
    notificationapi.Send(
        notificationapi.SendRequest{
            Type: "welcome_sms",
            To: notificationapi.User{
                Id:     "user123",
                Number: "+16175551212",  // Required for SMS notifications (E.164 format)
            },
            Parameters: parameters,
        },
    )
}

using NotificationApi.Server;
using NotificationApi.Server.Models;

// Initialize
var notificationApi = new NotificationApiServer("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET");

// Create user
var user = new NotificationUser("user123")
{
    TelephoneNumber = "+16175551212"  // Required for SMS notifications (E.164 format)
};

// Create parameters
var parameters = new Dictionary<string, object>
{
    { "firstName", "John" },
    { "companyName", "Acme Corp" }
};

// Send SMS notification
await notificationApi.Send(new SendNotificationData("welcome_sms", user)
{
    Type = "welcome_sms",
    To = user,
    Parameters = parameters
});

import com.notificationapi.NotificationApi;
import com.notificationapi.model.NotificationRequest;
import com.notificationapi.model.User;
import java.util.HashMap;
import java.util.Map;

// Initialize
NotificationApi api = new NotificationApi("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET");

// Create user
User user = new User("user123")
    .setNumber("+16175551212");  // Required for SMS notifications (E.164 format)

// Create parameters
Map<String, Object> parameters = new HashMap<>();
parameters.put("firstName", "John");
parameters.put("companyName", "Acme Corp");

// Send SMS notification
NotificationRequest request = new NotificationRequest("welcome_sms", user)
    .setType("welcome_sms")
    .setTo(user)
    .setParameters(parameters);

String response = api.send(request);

# Initialize
notificationapi = NotificationAPI.new("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")

# Send SMS notification
notificationapi.send({
  type: 'welcome_sms',
  to: {
    id: 'user123',
    number: '+16175551212'  # Required for SMS notifications (E.164 format)
  },
  parameters: {
    firstName: 'John',
    companyName: 'Acme Corp'
  }
})