Client libraries

from notifications_python_client.notifications import NotificationsAPIClient

# Initialize client with API key
client = NotificationsAPIClient(api_key="your-api-key-here")

# Send SMS
response = client.send_sms_notification(
    phone_number="+447900900123",
    template_id="f33517ff-2a88-4f6e-b855-c550268ce08a",
    personalisation={
        "name": "John Smith"
    },
    reference="customer-1234"
)

print(f"Notification ID: {response['id']}")

# Send email
response = client.send_email_notification(
    email_address="[email protected]",
    template_id="a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d",
    personalisation={
        "name": "Jane Doe",
        "amount": "£25.00"
    }
)

# Get notification status
notification = client.get_notification_by_id(response['id'])
print(f"Status: {notification['status']}")

# List notifications
notifications = client.get_all_notifications(
    template_type="email",
    status="delivered"
)

bundle install

gem install notifications-ruby-client

require 'notifications/client'

# Initialize client
client = Notifications::Client.new(api_key: 'your-api-key-here')

# Send SMS
response = client.send_sms(
  phone_number: '+447900900123',
  template_id: 'f33517ff-2a88-4f6e-b855-c550268ce08a',
  personalisation: {
    name: 'John Smith'
  },
  reference: 'customer-1234'
)

puts "Notification ID: #{response.id}"

# Send email
response = client.send_email(
  email_address: '[email protected]',
  template_id: 'a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d',
  personalisation: {
    name: 'Jane Doe',
    amount: '£25.00'
  }
)

# Get notification
notification = client.get_notification(response.id)
puts "Status: #{notification.status}"

# List notifications
notifications = client.get_notifications(
  template_type: 'email',
  status: 'delivered'
)

import uk.gov.service.notify.NotificationClient;
import uk.gov.service.notify.Notification;
import uk.gov.service.notify.SendSmsResponse;
import uk.gov.service.notify.SendEmailResponse;

import java.util.HashMap;

public class NotifyExample {
    public static void main(String[] args) {
        // Initialize client
        NotificationClient client = new NotificationClient("your-api-key-here");
        
        try {
            // Send SMS
            HashMap<String, String> personalisation = new HashMap<>();
            personalisation.put("name", "John Smith");
            
            SendSmsResponse smsResponse = client.sendSms(
                "f33517ff-2a88-4f6e-b855-c550268ce08a",  // template ID
                "+447900900123",                           // phone number
                personalisation,
                "customer-1234"                            // reference
            );
            
            System.out.println("Notification ID: " + smsResponse.getNotificationId());
            
            // Send email
            SendEmailResponse emailResponse = client.sendEmail(
                "a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d",  // template ID
                "[email protected]",                        // email address
                personalisation,
                "customer-5678"                            // reference
            );
            
            // Get notification
            Notification notification = client.getNotificationById(
                emailResponse.getNotificationId().toString()
            );
            System.out.println("Status: " + notification.getStatus());
            
        } catch (Exception e) {
            System.err.println("Error: " + e.getMessage());
        }
    }
}

const NotifyClient = require('notifications-node-client').NotifyClient;

// Initialize client
const notifyClient = new NotifyClient('your-api-key-here');

// Send SMS
notifyClient.sendSms(
  'f33517ff-2a88-4f6e-b855-c550268ce08a',  // template ID
  '+447900900123',                          // phone number
  {
    personalisation: {
      name: 'John Smith'
    },
    reference: 'customer-1234'
  }
).then(response => {
  console.log('Notification ID:', response.data.id);
}).catch(err => {
  console.error('Error:', err);
});

// Send email
notifyClient.sendEmail(
  'a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d',  // template ID
  '[email protected]',                        // email address
  {
    personalisation: {
      name: 'Jane Doe',
      amount: '£25.00'
    },
    reference: 'customer-5678'
  }
).then(response => {
  console.log('Notification ID:', response.data.id);
});

// Get notification (async/await)
async function checkNotification(notificationId) {
  try {
    const notification = await notifyClient.getNotificationById(notificationId);
    console.log('Status:', notification.data.status);
  } catch (err) {
    console.error('Error:', err);
  }
}

// List notifications
notifyClient.getNotifications(
  'email',      // template type
  'delivered',  // status
  '',           // reference
  ''            // older than
).then(response => {
  console.log('Notifications:', response.data.notifications);
});