Quick Start

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

You can generate an API key from your Dashboard at any time

The best way to interact with our API is to use one of our official libraries:

Make your first request

To make your first request, send an authenticated request to the SMS endpoint. This will allow you to send SMS to a single phone number at a time.

Send SMS

POST https://api.getspendo.com/gateway/api/v1/send/bulk/sms

Send SMS to a specific Phone Number

Headers

Name	Type	Description
apiKey*	String

Request Body

Name	Type	Description
from*	string	Sender ID
message*	string	The Message Body
to*	string	The PhoneNumber

200 SMS successfully sent

{
  "success": true,
  "message": "Message sent",
  "code": 0,
  "data": null
}

401 SMS not sent

{
  "success": false,
  "message": "Error sending message",
  "code": 0,
  "data": null
}

Good to know: You can use our API Method block to fully test all the API method.

Take a look at how you might call this method using our official libraries, or via curl:

curl

curl --location --request POST 'https://api.getspendo.com/gateway/api/v1/send/sms' \
--header 'apiKey: test_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
  "from": "string",
  "message": "string",
  "to": "string"
}'

Node

var axios = require('axios');
var data = JSON.stringify({
  "from": "string",
  "message": "string",
  "to": "string"
});

var config = {
  method: 'post',
  url: 'https://api.getspendo.com/gateway/api/v1/send/sms',
  headers: { 
    'apiKey': 'test_api_key', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Python

import http.client
import json

conn = http.client.HTTPSConnection("api.getspendo.com")
payload = json.dumps({
  "from": "string",
  "message": "string",
  "to": "string"
})
headers = {
  'apiKey': 'test_api_key',
  'Content-Type': 'application/json'
}
conn.request("POST", "/gateway/api/v1/send/sms", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.getspendo.com/gateway/api/v1/send/sms',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
  "from": "string",
  "message": "string",
  "to": "string"
}',
  CURLOPT_HTTPHEADER => array(
    'apiKey: test_api_key',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"from\": \"string\",\n  \"message\": \"string\",\n  \"to\": \"string\"\n}");
Request request = new Request.Builder()
  .url("https://api.getspendo.com/gateway/api/v1/send/sms")
  .method("POST", body)
  .addHeader("apiKey", "test_api_key")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

Javascript

var settings = {
  "url": "https://api.getspendo.com/gateway/api/v1/send/sms",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "apiKey": "test_api_key",
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({
    "from": "string",
    "message": "string",
    "to": "string"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});