Versand

Senden Sie eine SMS mit POST /v1/messages

Als Markdown anzeigen OpenAPI-Spezifikation

POST/v1/messages

Senden Sie einen Text an eine Nummer. Die Kosten werden vom Guthaben abgezogen, wenn die Anfrage akzeptiert wird.

Anfragekörper

tostringerforderlich
Die Nummer im internationalen Format, zum Beispiel +14155550123. Leerzeichen, Bindestriche, Klammern und ein 00-Präfix werden entfernt.
textstringerforderlich
Die Nachricht. Bis zu 10 Segmente; siehe Text und Segmente.
referencestringoptional
Ihre eigene ID, bis zu 100 Zeichen. Sie wird im Nachrichtenobjekt und in jedem Webhook zurückgegeben.
send_atstringoptional
ISO 8601-Zeit zum Senden, 2 Minuten bis 45 Tage im Voraus. Ohne sie wird die Nachricht sofort in die Warteschlange gestellt.

Fügen Sie einen Idempotency-Key-Header hinzu, um Wiederholungen sicher zu machen: siehe Idempotenz.

curl https://bulksmsapi.cc/v1/messages \
  -H "Authorization: Bearer $BULKSMSAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+14155550123",
    "text": "Your Northwind code is 482913. It expires in 10 minutes.",
    "reference": "login-7781"
  }'

// Node.js 18 or newer (built-in fetch)
const res = await fetch("https://bulksmsapi.cc/v1/messages", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BULKSMSAPI_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    to: "+14155550123",
    text: "Your Northwind code is 482913. It expires in 10 minutes.",
    reference: "login-7781",
  }),
});
const message = await res.json();
console.log(res.status, message.id, message.status, message.price);

# Python 3, standard library only
import json, os, urllib.request

req = urllib.request.Request(
    "https://bulksmsapi.cc/v1/messages",
    data=json.dumps({
        "to": "+14155550123",
        "text": "Your Northwind code is 482913. It expires in 10 minutes.",
        "reference": "login-7781",
    }).encode(),
    headers={
        "Authorization": "Bearer " + os.environ["BULKSMSAPI_KEY"],
        "Content-Type": "application/json",
        "User-Agent": "northwind-app/1.0",
    },
    method="POST",
)
with urllib.request.urlopen(req) as res:
    message = json.load(res)
print(res.status, message["id"], message["status"], message["price"])

<?php
// PHP 7.4 or newer with the curl extension
$ch = curl_init("https://bulksmsapi.cc/v1/messages");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("BULKSMSAPI_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "to" => "+14155550123",
        "text" => "Your Northwind code is 482913. It expires in 10 minutes.",
        "reference" => "login-7781",
    ]),
]);
$message = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $message["id"], " ", $message["status"], "\n";

// Go 1.20 or newer, standard library only
package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
	"os"
)

func main() {
	body, _ := json.Marshal(map[string]any{
		"to":        "+14155550123",
		"text":      "Your Northwind code is 482913. It expires in 10 minutes.",
		"reference": "login-7781",
	})
	req, _ := http.NewRequest("POST", "https://bulksmsapi.cc/v1/messages", bytes.NewReader(body))
	req.Header.Set("Authorization", "Bearer "+os.Getenv("BULKSMSAPI_KEY"))
	req.Header.Set("Content-Type", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	var message map[string]any
	json.NewDecoder(res.Body).Decode(&message)
	fmt.Println(res.StatusCode, message["id"], message["status"], message["price"])
}

202 AcceptedJSON

{
  "id": "msg_8F3K2Q9TZ1MX",
  "object": "message",
  "batch_id": "bat_4M7Q1X0PK2RS",
  "to": "+14155550123",
  "country": "US",
  "text": "Your Northwind code is 482913. It expires in 10 minutes.",
  "segments": 1,
  "price": "0.00507",
  "currency": "USD",
  "status": "queued",
  "error": null,
  "reference": "login-7781",
  "created_at": "2026-11-07T09:30:12.418Z",
  "sent_at": null,
  "done_at": null
}

Das Nachrichtenobjekt

Felder

idstring
Nachrichten-ID, msg_ gefolgt von 12 Zeichen.
objectstring
Immer Nachricht.
batch_idstring
Der Batch, zu dem die Nachricht gehört (eine einzelne Nachricht erhält auch einen Batch).
tostring
Die Nummer im E.164-Format, nach der Bereinigung.
countrystring
ISO 3166-Code des Landes, für das die Nummer bewertet wurde.
textstring
Der Text wie gesendet, Merge-Felder ausgefüllt.
segmentsinteger
Anzahl der SMS-Segmente, die der Text verwendet.
pricestring
Preis dieser Nachricht in USD, 5 Dezimalstellen (Preis pro Segment mal Segmente).
currencystring
Immer USD.
statusstring
geplant, in der Warteschlange, gesendet, zugestellt, fehlgeschlagen oder abgebrochen.
errorobject or null
Für fehlgeschlagene oder abgebrochene Nachrichten: Code und Nachricht.
referencestring or null
Ihre eigene Referenz aus der Anfrage.
created_atstring
Wann die Anfrage akzeptiert wurde (ISO 8601, UTC).
sent_atstring or null
Wann die Nachricht an das Netzwerk übergeben wurde.
done_atstring or null
Wann der endgültige Status (zugestellt, fehlgeschlagen oder abgebrochen) festgelegt wurde.

Eine Nachricht abrufen

GET/v1/messages/{id}

Eine Nachricht anhand ihrer msg_ ID. Nachrichten anderer Konten antworten mit 404.

curl https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX \
  -H "Authorization: Bearer $BULKSMSAPI_KEY"

const res = await fetch("https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX", {
  headers: { Authorization: `Bearer ${process.env.BULKSMSAPI_KEY}` },
});
const message = await res.json();
console.log(message.status, message.error);

import json, os, urllib.request

req = urllib.request.Request(
    "https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX",
    headers={"Authorization": "Bearer " + os.environ["BULKSMSAPI_KEY"], "User-Agent": "northwind-app/1.0"},
)
with urllib.request.urlopen(req) as res:
    message = json.load(res)
print(message["status"], message["error"])

<?php
$ch = curl_init("https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("BULKSMSAPI_KEY")],
]);
$message = json_decode(curl_exec($ch), true);
echo $message["status"], "\n";

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("BULKSMSAPI_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	var message map[string]any
	json.NewDecoder(res.Body).Decode(&message)
	fmt.Println(message["status"], message["error"])
}

Nachrichten auflisten

GET/v1/messages

Nachrichten des Kontos, neueste zuerst.

Abfrageparameter

batch_idstringoptional
Nur Nachrichten dieses bat_ Batches.
statusstringoptional
geplant, in der Warteschlange, gesendet, zugestellt, fehlgeschlagen oder abgebrochen.
limitintegeroptional
1 bis 100, Standard 20.
starting_afterstringoptional
Eine msg_ ID: Die Seite beginnt danach. Verwenden Sie die letzte ID der vorherigen Seite.

curl "https://bulksmsapi.cc/v1/messages?status=failed&limit=50" \
  -H "Authorization: Bearer $BULKSMSAPI_KEY"

200 OKJSON

{
  "object": "list",
  "data": [ { "id": "msg_8F3K2Q9TZ1MX", "object": "message", "status": "failed", "...": "..." } ],
  "has_more": false
}

ZurückAuthentifizierung WeiterBatches