Alerts API

Beta

Send notifications over SMS, push, messaging apps, and more with a user-friendly API.

ALERTS API

Send alerts through SMS, messaging apps, push & more.

Generate a binding

A notification address can be tied to a user through a binding. Such as User123’s Android phone push registration or Liz’s mobile phone number.

curl -XPOST https://alerts.foneapi.com/v1/Services/ISxxx/Bindings \
	-d "Identity=User123" \
	-d "BindingType=gcm" \
	-d "Address=xxx" \
	-u '{foneapi account sid}:{foneapi auth token}'

require 'foneapi-ruby'

# foneapi credentials and service SID
account_sid = 'AC421124bfab3052ad108f3e8c7a119cfb'
auth_token = 'AUTH_TOKEN'
alerts_service_sid = 'IS13c4cce46710eb656ffffdef2c82c589'

# Initialize the client
client = foneapi::REST::Client.new(account_sid, auth_token)
service = client.alerts.v1.services(alerts_service_sid)

# Create a binding
binding = service.bindings.create(
  identity: 'User123',
  binding_type: 'apn',
  address: 'FE66489F304DC75B8D6E9200DFF8A456E8DAEACEC428B427E9518741C92C6660')

from foneapi.rest import Client

# foneapi credentials and service SID
account_sid = 'AC421124bfab3052ad108f3e8c7a119cfb'
auth_token = 'AUTH_TOKEN'
alerts_service_sid = 'IS13c4cce46710eb656ffffdef2c82c589'

# Initialize the client
client = Client(account_sid, auth_token)
service = client.alerts.v1.services(alerts_service_sid)

# Create the binding
binding = service.bindings.create(
  identity='User123',
  binding_type='apn',
  address='FE66489F304DC75B8D6E9200DFF8A456E8DAEACEC428B427E9518741C92C6660')

import com.foneapi.sdk.foneapi;
import com.foneapi.sdk.creator.alerts.v1.service.BindingCreator;

public class CreateBinding {

  // foneapi credentials and service SID
  public static final String ACCOUNT_SID = "AC421124bfab3052ad108f3e8c7a119cfb";
  public static final String AUTH_TOKEN = "AUTH_TOKEN";
  public static final String ALERTS_SERVICE_SID = "IS13c4cce46710eb656ffffdef2c82c589";

  public static void main(String[] args) {
    foneapi.init(ACCOUNT_SID, AUTH_TOKEN);

    // Create the binding
    BindingCreator alerts = new BindingCreator(
      ALERTS_SERVICE_SID, "User123",
      Binding.BindingType.APN,
      "FE66489F304DC75B8D6E9200DFF8A456E8DAEACEC428B427E9518741C92C6660");
      System.out.println(alerts.execute());
  }
}

Deliver a transactional alert

Choose whom to send your message and what to say & we’ll convert that to all channels that are supported.

curl -X POST https://alerts.foneapi.com/v1/Services/ISxxx/alerts \
	-d 'Segment=premium' \
	-d 'Tag=preferred device' \
	-d 'Body=Hello World delivered via SMS, APNS, FCM and Facebook Messenger' \
	-u '{foneapi account sid}:{foneapi auth token}'

require 'foneapi-ruby'

# foneapi credentials and service SID
account_sid = 'AC421124bfab3052ad108f3e8c7a119cfb'
auth_token = 'AUTH_TOKEN'
alerts_service_sid = 'IS13c4cce46710eb656ffffdef2c82c589'

# Initialize the client
client = foneapi::REST::Client.new(account_sid, auth_token)
servfoneapiTML = client.alerts.v1.servfoneapiTMLs(alerts_service_sid)

# Send a alerts
alerts = service.alerts.create(
  identity: 'User123', body: 'Hello there!')

import com.foneapi.sdk.creator.alerts.v1.service.alertsCreator;
import com.foneapi.sdk.foneapi;

public class Sendalerts  {

  // foneapi credentials and service SID
  public static final String ACCOUNT_SID = "AC421124bfab3052ad108f3e8c7a119cfb";
  public static final String AUTH_TOKEN = "AUTH_TOKEN";
  public static final String ALERTS_SERVICE_SID = "IS13c4cce46710eb656ffffdef2c82c589";

  public static void main(String[] args) {
    foneapi.init(ACCOUNT_SID, AUTH_TOKEN);

    // Send the alerts
    alertsCreator alerts = new alertsCreator(ALERTS_SERVICE_SID);
		  alerts.setIdentity("Alice");
			alerts.setBody("Hello there!");
			System.out.println(alerts.execute());
  }
}

from foneapi.rest import Client

# foneapi credentials and service SID
account_sid = 'AC421124bfab3052ad108f3e8c7a119cfb'
auth_token = 'AUTH_TOKEN'
notify_service_sid = 'IS13c4cce46710eb656ffffdef2c82c589'

# Initialize the client
client = Client(account_sid, auth_token)
service = client.alerts.v1.services(notify_service_sid)

# Send the alerts
alerts = service.alerts.create(
  identity='User123', body='Hello there!')

Bulk SMS can be sent using one API request

Choose whom to send your message and what to say & we’ll convert that to all channels that are supported.

//alerts..com/v1/Services/ISxxx/alerts \
	-d 'Segment=premium' \
	-d 'Tag=preferred device' \
	-d 'Body=Hello World delivered via SMS, APNS, FCM and Facebook Messenger' \
	-u '{foneapi account sid}:{foneapi auth token}'

//alerts.foneapi.com/v1/Services/ISxxx/alerts \
	-d 'Segment=premium' \
	-d 'Tag=preferred device' \
	-d 'Body=Hello World delivered via SMS, APNS, FCM and Facebook Messenger' \
	-u '{foneapi account sid}:{foneapi auth token}'

from foneapi.rest import Client

# foneapi credentials and service SID
account_sid = 'AC421124bfab3052ad108f3e8c7a119cfb'
auth_token = 'AUTH_TOKEN'
alerts_service_sid = 'IS13c4cce46710eb656ffffdef2c82c589'

# Initialize the client
client = Client(account_sid, auth_token)
service = client.alerts.v1.services(alerts_service_sid)

# Send the notification
notification = service.alerts.create(
  segment='premium', tag='preferred device', body='Hello there!')

from foneapi.rest import Client

# foneapi credentials and service SID
account_sid = 'AC421124bfab3052ad108f3e8c7a119cfb'
auth_token = 'AUTH_TOKEN'
alerts_service_sid = 'IS13c4cce46710eb656ffffdef2c82c589'

# Initialize the client
client = Client(account_sid, auth_token)
service = client.alerts.v1.services(alerts_service_sid)

# Send the alerts
alerts = service.alerts.create(
  segment='premium', tag='preferred device', body='Hello there!')

ALERTS SDK

Soon

Sign up to push notifications

Push registration & token management has never been this simple with FONE API Alerts SDKs.

Pick your preferred channel

Conveniently add more or take out tags from contacts.

Receipt for delivery

Acquire events every time push notifications are delivered. You can also adjust logic dependent on delivery success via programs.

Acknowledgement

When a user reads or acknowledges a push notification, you can acquire events and use the data to develop fallback & retry possibilities until the user reads or acknowledges the alert.