RapidAPI logo

Octopush SMS

FREE
By Octopush
Updated 4 months ago
3.4/10
Popularity Score
1304ms
Latency
100%
Success Rate

Octopush SMS API Documentation

Octopush SMS allow you to automatically send SMS to over 200 countries. We provide API in either HTTP or SMTP and in 5 languages: Java, C#, VBA, PHP and ASP. Best ever simple service with a scalable cloud architecture!

View API Details
POST/api/sms
POST/api/sms
Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
user_loginSTRING
REQUIREDLogin Octopush (your email)
api_keySTRING
REQUIREDAvailable on Octopush -> API
sms_recipientsSTRING
REQUIREDEnter the numbers of your recipients, preceded by the international dialling code and separated by a comma (+33600001012,33604030201, ...).
sms_textSTRING
REQUIREDText of your SMS. The cost depends of the length of your text. Do not forget to add "STOP au XXXXX" at the end of your text, unless the SMS won't be sent. Please refer to our doc to know more about our API : http://www.octopush.com/public/docs/envoyer-des-sms-avec-octopush.pdf
sms_senderSTRING
REQUIREDAppears at the top of your message. It can be a company name, an event name, etc...
sms_typeSTRING
REQUIREDType of your SMS. FR : premium - WWW : world
Code Snippet
unirest.post("https://octopush.p.rapidapi.com/api/sms")
.header("X-RapidAPI-Host", "octopush.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.send("user_login=Login")
.send("api_key=API Key")
.send("sms_recipients=SMS recipients")
.send("sms_text=STOP au XXXXX")
.send("sms_sender=Sender id")
.send("sms_type=FR")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
Sample Response
General
Request URL: https://octopush.p.rapidapi.com/api/sms
Request Method: POST
Response Headers
Response Body
<?xml version="1.0" encoding="UTF-8"?>
<octopush>
  <error_code>100</error_code>
</octopush>
Log inSign up

Install SDK for NodeJS

Installing

To utilize unirest for node.js install the the npm module:

$ npm install unirest

After installing the npm package you can now start simplifying requests like so:

var unirest = require('unirest');

Creating Request

unirest.post("https://octopush.p.rapidapi.com/api/sms")
.header("X-RapidAPI-Host", "octopush.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.send("user_login=Login")
.send("api_key=API Key")
.send("sms_recipients=SMS recipients")
.send("sms_text=STOP au XXXXX")
.send("sms_sender=Sender id")
.send("sms_type=FR")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication