Entwicklerdokumentation
Eine RESTful-API mit Authentifizierung über ein Zugriffstoken und UTF-8-JSON in Anfrage wie Antwort. Zu jedem Endpunkt unten gehört ein curl-Beispiel, das sich unverändert ausführen lässt.
SMS-API — Nachrichten senden
Lösen Sie den Versand direkt aus Ihren eigenen Systemen aus. to nimmt eine einzelne Nummer auf oder mehrere durch Kommas getrennt (bis zu 1000 je Aufruf); nach der Annahme liefert der Aufruf eine message_id, mit der sich der Zustellstatus abfragen lässt.
Header zur Authentifizierung
AuthorizationAuthorization: Bearer {api_token}AcceptNachricht senden
Sendet eine Text-SMS an eine oder mehrere Nummern. In der Antwort gibt segments an, wie viele Nachrichten dieser Versand belegt, und cost die Gesamtkosten.
Endpunkt
POST https://redsmsbox.com/api/v1/sms/sendParameter
tomessagechannelsender_idschedule_atcallback_urlBeispielanfrage
curl -X POST https://redsmsbox.com/api/v1/sms/send \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"to": "+8613800138000",
"message": "【RedsmsBox】您的验证码是 123456，5 分钟内有效。"
}'Antwort
{
"ok": true,
"message_id": "msg_3f7a91",
"status": "queued",
"to": "+8613800138000",
"segments": 1,
"cost": "0.06",
"currency": "USD"
}{
"ok": false,
"error_code": "invalid_parameter",
"error": "The body is not valid JSON, or a field failed validation"
}Fehlerantworten verwenden immer diesen Rahmen. Das Feld error ist stets englisch und folgt nicht der Anzeigesprache — es richtet sich an Maschinen und an die Protokollauswertung. Verzweigen Sie über error_code; gleichen Sie niemals den Text von error ab. Die vollständige Codetabelle steht in der Entwicklerdokumentation der Konsole.
Zustellstatus abfragen
Fragt den aktuellen Status einer einzelnen Nachricht und den Zeitpunkt der Betreiberquittung über die beim Senden zurückgegebene message_id ab.
Endpunkt
GET https://redsmsbox.com/api/v1/sms/{message_id}Parameter
message_idBeispielanfrage
curl -X GET https://redsmsbox.com/api/v1/sms/msg_3f7a91 \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'Antwort
{
"ok": true,
"message_id": "msg_3f7a91",
"status": "delivered",
"to": "+8613800138000",
"segments": 1,
"cost": "0.06",
"currency": "USD",
"submitted_at": "2026-08-16T09:12:31Z",
"delivered_at": "2026-08-16T09:12:34Z"
}{
"ok": false,
"error_code": "invalid_parameter",
"error": "The body is not valid JSON, or a field failed validation"
}Fehlerantworten verwenden immer diesen Rahmen. Das Feld error ist stets englisch und folgt nicht der Anzeigesprache — es richtet sich an Maschinen und an die Protokollauswertung. Verzweigen Sie über error_code; gleichen Sie niemals den Text von error ab. Die vollständige Codetabelle steht in der Entwicklerdokumentation der Konsole.
Gesendete Nachrichten auflisten
Blättert durch den Versandverlauf dieses Kontos, gefiltert nach Zeit und Status.
Endpunkt
GET https://redsmsbox.com/api/v1/smsParameter
statusstartendpageBeispielanfrage
curl -X GET 'https://redsmsbox.com/api/v1/sms?status=delivered&page=1' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'Antwort
{
"ok": true,
"page": 1,
"total": 2,
"items": [
{
"message_id": "msg_3f7a91",
"status": "delivered",
"to": "+8613800138000",
"segments": 1,
"cost": "0.06"
}
]
}{
"ok": false,
"error_code": "invalid_parameter",
"error": "The body is not valid JSON, or a field failed validation"
}Fehlerantworten verwenden immer diesen Rahmen. Das Feld error ist stets englisch und folgt nicht der Anzeigesprache — es richtet sich an Maschinen und an die Protokollauswertung. Verzweigen Sie über error_code; gleichen Sie niemals den Text von error ab. Die vollständige Codetabelle steht in der Entwicklerdokumentation der Konsole.
Nicht gefunden, was Sie brauchen? Sprechen Sie uns an
Schildern Sie Ihren Anwendungsfall, und der Kundenservice meldet sich mit dem zulässigen Umfang, einer Routenempfehlung und dem Preis.