Build with SMSBlast.

Send an SMS

Send a text (or an MMS with an image) from a verified number you own to one recipient or up to 100 at once. Recipients who have opted out are skipped automatically.

Endpoint

Headers

• Authorization: Bearer YOUR_API_KEY
• Content-Type: application/json

Request body

• to Phone number (string) or array of phone numbers (max 100), E.164 format.
• from Required. Your verified phone number to send from (E.164 format, e.g. +18005551234).
• message SMS message content (string). Supports {{firstName}} and other placeholders, filled in per recipient from their contact.
• name (optional) Contact name. Only applied when sending to a single recipient; sets and overwrites that contact's first and last name.
• mediaUrl (optional) Public https image URL to send as an MMS, attached to every recipient and billed at the MMS rate. Carriers accept jpg, png, gif, or webp up to 5MB.

curl -X POST https://app.smsblast.io/api/v2/sms/send -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"to":"+15551234567","from":"+18005551234","message":"Hello from SMSBlast API!","name":"Jane Doe"}'

const axios = require('axios');

axios.post('https://app.smsblast.io/api/v2/sms/send', {
  to: '+15551234567',
  from: '+18005551234',
  message: 'Hello from SMSBlast API!',
  name: 'Jane Doe'
}, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
})
.then(response => console.log(response.data))
.catch(error => console.error(error));

<?php
$apiKey = 'YOUR_API_KEY';
$url = 'https://app.smsblast.io/api/v2/sms/send';

$data = [
    'to' => '+15551234567',
    'from' => '+18005551234',
    'message' => 'Hello from SMSBlast API!',
    'name' => 'Jane Doe'
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer ' . $apiKey,
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$result = json_decode($response, true);
print_r($result);

Response

{
  "success": true,
  "sent": 1,
  "failed": 0,
  "totalCost": "0.0150",
  "results": [
    {
      "to": "+15551234567",
      "status": "sent",
      "messageSid": "SM...",
      "segments": 1,
      "cost": 0.015
    }
  ]
}

errors is included only when some recipients could not be sent (for example opted out), each with a to and an error reason.

Error responses

• 401 Missing or invalid API key.
• 400 Missing "from" field, phone number not found or not verified, or invalid request body.
• 402 Insufficient balance.

Opt out a contact

Stop a contact from receiving further messages. Matched by phone number within your account. Idempotent.

Endpoint

Headers

• Authorization: Bearer YOUR_API_KEY
• Content-Type: application/json

Request body

• number Required. The contact's phone number (E.164, e.g. +15551234567).

curl -X POST https://app.smsblast.io/api/v2/contacts/opt-out -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"number":"+15551234567"}'

const axios = require('axios');

axios.post('https://app.smsblast.io/api/v2/contacts/opt-out', {
  number: '+15551234567'
}, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
})
.then(response => console.log(response.data))
.catch(error => console.error(error));

<?php
$apiKey = 'YOUR_API_KEY';
$ch = curl_init('https://app.smsblast.io/api/v2/contacts/opt-out');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['number' => '+15551234567']));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer ' . $apiKey,
    'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));

Response

{
  "success": true,
  "optedOut": 1,
  "alreadyOptedOut": false,
  "number": "+15551234567"
}

Returns 404 if no contact matches the number. alreadyOptedOut is true when the contact was already opted out.

Error responses

• 401 Missing or invalid API key.
• 400 Missing or invalid number.
• 404 No contact in your account matches that number.

Account

Returns your account info, handy for confirming an API key works and checking your balance and sender number. No cost.

Endpoint

Headers

• Authorization: Bearer YOUR_API_KEY

curl https://app.smsblast.io/api/v2/me -H "Authorization: Bearer YOUR_API_KEY"

const axios = require('axios');

axios.get('https://app.smsblast.io/api/v2/me', {
  headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
})
.then(response => console.log(response.data))
.catch(error => console.error(error));

<?php
$apiKey = 'YOUR_API_KEY';
$ch = curl_init('https://app.smsblast.io/api/v2/me');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $apiKey]);
$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));

Response

{
  "id": "org_uuid",
  "name": "Acme Inc",
  "balance": 42.50,
  "sender_number": "+18885551234",
  "sender_status": "verified"
}

Error responses

• 401 Missing or invalid API key.