Getting Started

Developing against PureSMS couldn’t be simpler with our REST API or official client libraries.

PureSMS is built directly on top of divergent Connect, so you’ll be using the Connect API directly to interact with the platform. We’ve done this so that as your application grows, you won’t have to change too much to migrate over to Connect and use more advanced functionality.

Setting things up

To get started, you’ll need to set up Connect properly.

Create a Workspace at PureSMS.
Open PureSMS
If you’re not live, make sure you’ve verified your Test Number so that you can send from “ConnectTest”.

Please note that only UK numbers are currently supported in Test Mode.

Where do I do this?
Within PureSMS, click “Settings” in the top navigation and then “Test Mode” down the left.
If you’re live (or want to go live soon), add at least one Sender name to your Workspace and the Country that you’ll be sending to.

Where do I do this?
Within PureSMS, click “Senders” in the top navigation and then “Create a Sender” at the top right.
You’ll be asked for a Sender Name, Sample Content and at least 1 Country to register the Sender in.

Sender names will be approved by PureSMS even whilst you’re testing. Try to add a real Sender name that you’ll be using in the future.
Learn more about Senders
Add a new API Key to your Workspace.

Where do I do this?
Within PureSMS, click “Settings” in the top navigation and then “API Keys” down the left. You can then click “Add API Key” at the top right.
🎉 Ready to go.

Sending your first SMS

Choose your preferred method to send your first SMS.

Installation

Install the Divergent.Connect package from NuGet:

dotnet add package Divergent.Connect

Setup

Choose the setup method that works best for your application:

var builder = WebApplication.CreateBuilder(args);

// Add Connect client
builder.AddDivergentConnect();

var app = builder.Build();

Add your configuration to appsettings.json:

{
  "Divergent": {
    "Connect": {
      "ApiKey": "your-api-key",
      "DefaultSmsSender": "YourSender"
    }
  }
}

public void ConfigureServices(IServiceCollection services)
{
    services.AddDivergentConnect(Configuration);
}

Add your configuration to appsettings.json:

{
  "Divergent": {
    "Connect": {
      "ApiKey": "your-api-key",
      "DefaultSmsSender": "YourSender"
    }
  }
}

using Divergent.Connect;

var smsClient = new ConnectClientBuilder()
    .WithApiKey("your-api-key")
    .WithDefaultSmsSender("YourSender")
    .BuildSmsClient();

Send your first SMS

// Inject IConnectSms into your service/controller (or use the manually built client)
public class MyService(IConnectSms smsClient)
{
    public async Task SendWelcomeSms(string phoneNumber)
    {
        await smsClient.SendSmsAsync(new ConnectSmsMessage
        {
            To = phoneNumber,       // E.164 format, e.g. "+447700900123"
            Content = "Hello world, from PureSMS!"
        });
    }
}

Installation

Install the @divergent/connect package from npm:

npm install @divergent/connect

Send your first SMS

import { ConnectClient } from '@divergent/connect';

const client = new ConnectClient({
  apiKey: process.env.DIVERGENT_CONNECT_API_KEY,
  defaultSmsSender: 'YourSender'
});

const result = await client.sms.send({
  to: '+447700900123',  // E.164 format
  content: 'Hello world, from PureSMS!'
});

console.log('SMS sent! ID:', result.id);

Paste this in your favourite terminal to send your first SMS. Don’t forget to replace the placeholders.

curl -X POST https://connect-api.divergent.cloud/sms/send \
  -H "X-Api-Key: { API_KEY }" \
  --json '{
    "sender": "{ SENDER_NAME }",
    "recipient": "{ RECIPIENT_NUMBER }",
    "content": "Hello world, from PureSMS!"
  }'