Dokumentacja endpointu do dodawania wiadomości SMS do kolejki wysyłkowej (tabela outbox).
POST application/json Auth: api_key w body JSON| Adres | https://api.softspm.pl/send_sms_api.php |
|---|---|
| Metoda HTTP | POST |
| Content-Type | application/json |
| Kodowanie | UTF-8 |
Klucz API należy wysłać w polu api_key w treści JSON.
Uwaga: klucz musi znajdować się na liście API_KEYS['send_sms_api.php'] po stronie serwera.
{
"api_key": "TWÓJ_KLUCZ_API",
"to": "+48XXXYYYZZZ",
"message": "Treść SMS",
"creator": "CRM"
}
| Parametr | Typ | Wymagany | Opis |
|---|---|---|---|
api_key | string | tak | Klucz API. |
to | string | tak | Numer odbiorcy. Dozwolone znaki: cyfry, +, spacje, myślniki, nawiasy. Max 30 znaków. |
message | string | tak | Treść SMS. Max 1530 znaków. |
creator | string | nie | Źródło wiadomości. Domyślnie API. Max 50 znaków. |
curl -X POST "https://api.softspm.pl/send_sms_api.php" \
-H "Content-Type: application/json" \
-d '{
"api_key":"TWÓJ_KLUCZ_API",
"to":"+48XXXYYYZZZ",
"message":"Przypomnienie o wydarzeniu jutro o 10:00",
"creator":"HydroNexis"
}'
const response = await fetch("https://api.softspm.pl/send_sms_api.php", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
api_key: "TWÓJ_KLUCZ_API",
to: "+48XXXYYYZZZ",
message: "Test API SMS",
creator: "Panel"
})
});
const data = await response.json();
console.log(response.status, data);
{
"status": "success",
"message": "SMS dodany do kolejki."
}
| HTTP | Komunikat | Znaczenie |
|---|---|---|
| 400 | Brak danych JSON w żądaniu. | Puste body. |
| 400 | Niepoprawny JSON. | Niepoprawna składnia JSON. |
| 400 | Brakuje pola 'to' lub 'message'. | Brak wymaganych pól. |
| 400 | Pole to ma nieprawidłowy format. | Nieprawidłowy numer telefonu. |
| 400 | Wiadomość jest zbyt długa. | Przekroczono limit długości message. |
| 400 | Pole creator jest zbyt długie. | Przekroczono limit długości creator. |
| 401 | Nieautoryzowany dostęp. | Błędny lub pusty klucz API. |
| 405 | Dozwolona jest tylko metoda POST. | Użyto innej metody HTTP. |
| 500 | Błąd połączenia z bazą danych. | Problem z połączeniem do DB. |
| 500 | Nie udało się dodać SMS-a. | Błąd przygotowania/wykonania zapytania SQL. |
api_key w logach aplikacyjnych.success.to lub message zwraca HTTP 400.to zwraca HTTP 400.message zwraca HTTP 400.api_key zwraca HTTP 401.