Programmable SMS

Intelligent Communications API

 

Build intelligent SMS messaging into your application.

  Wayne Finehout, Client Services | Jackson Lake, WY | Nikon

Introduction

Designed for developers

Shoutpoint’s Programmable SMS gives developers the keys to one of the industry’s largest and most reliable cloud communications platforms in a powerful API. The service allows you to programmatically send and receive both long code and short code SMS messages, read logs, and manage phone numbers.

Stuff you can build

Appointment Reminders
Automated Alerts
Contact Center Messaging
Marketing Notifications
Long Code SMS Masking
Two-Factor Authentication

How It Works

Shoutpoint’s Programmable SMS consists of two related services, a REST API and Callbacks:

REST API

Overview

The Shoutpoint REST API enables you to send SMS messages and read logs. It also allows you to manage your account, applications, phone numbers, and callback configurations.

You can view a full list of Shoutpoint’s REST API Methods on the API Reference.

 

Example Request // Send SMS Message

 

Callbacks

Overview

Shoutpoint’s Callbacks allow you to receive SMS messages. When an SMS is sent to an SMS enabled Shoutpoint phone number, Shoutpoint will send the message to the URL that you designate. Unlike Programmable Voice, Shoutpoint does not expect to receive a response to SMS messages.

Example Request // SMS Received

Getting Started

Get started with the basics of Shoutpoint’s Programmable SMS API.

Receive Messages

Overview

This tutorial is a step-by-step guide to setting up an SMS enabled number which receives a text message.

Prerequisites

Create an Account // Sign up for a Shoutpoint Portal Account
Make a Payment // After you sign up, Make a Payment in order to start sending and receiving SMS
Create an Application // Once you sign up for an account, Create an Application to get you API key
Get an API key // Finally, go to your Applications and click on ‘DETAIL’ to get your unique API key

Base URL // All URLs referenced in the documentation have the same base API endpoint (https://api.shoutpoint.com/v1), which is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

Tutorial

1. Provision A Phone Number

To receive an inbound SMS message, you need to search for an available ‘SMS enabled’ phone number, provision it, and assign it to CallFlows, using our REST API (Base URL: https://api.shoutpoint.com/v1).

To search for an available phone number, go to List Available Phone Numbers and prepare your query request. For SMS enabled numbers, make sure to set is_sms=true (see example query below).

Once, you have made your GET request, select a phone number from the list of results and ‘copy’ it. To provision the number, go to Provision Phone Numbers, ‘paste’ the number into your request body, assign it to CallFlows, and POST.

Now that you have provisioned your new SMS enabled phone number, it is time to configure the callback settings.

 

2. Configure Your Call Flow Callback

To quickly test an SMS, set your callback configuration URL to the RequestBin service following these steps:

A. Go to: http://requestb.in/

B. Check the ‘Private’ option

C. Click ‘Create a RequestBin’

D. Copy/paste your new RequestBin URL and phone number into the request body of Create Call Flow Callback and POST (see example request body below).

 

3. Text Your Number

Now you can text “Hello, World!” to the new phone number that you configured. If all went well, you should receive the text message.

Congratulations! You are now ready to send a text message from the number that you just programmed.

Send Messages

Overview

This tutorial is a step-by-step guide for generating an SMS to a cell phone number using the REST API.

Prerequisites

‘Receive Messages’ Tutorial // Make sure that you have completed the Receive Messages tutorial

 

Tutorial

1. Prepare your Request

To send a text message from the number that you programmed above, you will use the Send SMS method and copy/paste the following body:

2. Send an SMS

Once you have prepared your request body, POST it. If successful, you should receive the “Hello, World!” text message.

Congratulations! You can now send SMS messages from your Shoutpoint phone numbers. Next, you can point your number to a URL on your own server and start building intelligent SMS messaging into your application.