API SMS

POST https://api.ovh.com/1.0/sms/sms-aa1-1/jobs
{
  "message": "Test message",
  "receivers": ["+33601020304"],
  "senderForResponse": true
}

Odbiorca otrzyma wiadomość SMS o treści „Test message”, wysłaną ze skróconego numeru.
API zwróci komunikat zawierający liczbę wykorzystanych kredytów, prawidłowe i nieprawidłowe numery telefonów odbiorców, a także identyfikatory SMS-ów pozwalające śledzić ich status.

POST https://api.ovh.com/1.0/sms/sms-aa1-1/jobs
{
  "message": "Test message",
  "receivers": ["+33601020304"],
  "differedPeriod": 120,
  "senderForResponse": true
}

Możesz zaprogramować późniejszą wysyłkę SMS-a.

Skorzystaj z pola „differedPeriod”, aby przesunąć wysłanie wiadomości o 120 minut.

Status SMS-a sprawdzisz w polu „deliveryReceipt”:

GET https://api.ovh.com/1.0/sms/sms-aa1-1/outgoing/123456

Pole „deliveryReceipt” może zawierać następujące wartości:

• 0 → trwa wysyłanie
• 1 → wysłany
• 2 → odrzucony lub wygasł
• 4 → oczekuje w sieci operatora odbiorcy
• 8 → przekazany do sieci operatora odbiorcy
• 16 → nie może zostać niedostarczony.

Pole „ptt” zawiera dodatkowe informacje.

Pole „ptt” zwróci kod, którego opis dostępny będzie po zastosowaniu następującego wywołania:

https://api.ovh.com/1.0/sms/ptts
{
  "ptt":  4
}

OVHcloud może powiadamiać Cię w czasie rzeczywistym o zmianie statusu SMS-ów, za pośrednictwem połączenia HTTP.

Skonfiguruj adres URL, który ma być wywoływany:

PUT https://api.ovh.com/1.0/sms/sms-aa1-1                        {                            "callBack": "http://www.monsite.com/callbackSmsOvh.php"                        }                    

Po skonfigurowaniu powiadomień, w przypadku każdej zmiany statusu SMS-a następuje wywołanie adresu URL przy użyciu następujących parametrów:

• Id → ID SMS-a
• dlr: status „deliveryReceipt”
• ptt → status „ptt”
• data → data aktualizacji statusu
• sender → nadawca SMS-a
• receiver → numer odbiorcy SMS-a.

Możesz złożyć zamówienie za pośrednictwem API OVHcloud:

POST https://api.ovh.com/1.0/order/sms/sms-aa1-1/credits                        {                            "quantity":     100                        }                    

Konto może zostać doładowane automatycznie, kiedy osiągniesz określony limit kredytów.

Wygenerowane zostanie zamówienie, a opłata zostanie pobrana automatycznie przy użyciu sposobu płatności skonfigurowanego na koncie klienta OVHcloud.

Ustaw automatyczne doładowanie 100 kredytów, gdy na koncie pozostanie Ci mniej niż 10 kredytów:

PUT https://api.ovh.com/1.0/sms/sms-aa1-1                        {                            "automaticRecreditAmount":              100,                            "creditThresholdForAutomaticRecredit":  10,                        }                    

Aby z wyprzedzeniem sprawdzić, ile kosztuje wysłanie wiadomości, wykonaj następujące wywołanie:

GET https://api.ovh.com/1.0//sms/sms-aa1-1/seeOffers)                        {                            "countryDestination": "pl",                            "countryCurrencyPrice": "pl",                            "quantity": 1000,                        }                    

To połączenie zwróci strukturę, dzięki której poznasz cenę 1000 SMS-ów w walucie kraju docelowego (np. PLN dla Polski).

Aby zoptymalizować wysyłkę grupowych SMS-ów, możesz wstępnie załadować listę odbiorców do pliku CSV.

Utwórz plik z listą odbiorców:

POST https://api.ovh.com/1.0/sms/sms-aa1-1/receivers                        {                            "csvUrl":       "http://monsite.com/mes_destinataires.csv",                            "description":  "Liste de mes clients",                            "slotId":       1                        }                    

Plik musi zawierać co najmniej jedną kolumnę „number” z numerami telefonów odbiorców. Opcjonalnie możesz utworzyć dodatkowe kolumny, które będą używane do wstawiania zmiennych dla kolejnych wysyłek. Przykładowy plik:

number;name;age                        +48601000000;Krzysztof;47                        +48601000000;Anna;36                        +48601000000;Ewa;39                    

Aby wysłać wiadomość SMS do wszystkich odbiorców tego pliku, wystarczy skorzystać z następującego wywołania:

POST https://api.ovh.com/1.0/sms/sms-aa1-1/jobs                        {                            "message":              „Dzień dobry #NAME, wszystkiego najlepszego z okazji #AGE# urodzin!",                            "receiversSlotId":      1,                            "senderForResponse":    true                            "tag": "MojaKampania" }                    

Dzięki temu wywołaniu wszyscy trzej odbiorcy otrzymają spersonalizowaną wiadomość.
Na przykład Krzysztof otrzyma wiadomość „Dzień dobry Krzysztof, wszystkiego najlepszego z okazji 47 urodzin!”.

Jeśli dodasz parametr „tag”, możesz wyszukać SMS-y przyporządkowane do tej wysyłki za pomocą następującego wywołania:

GET https://api.ovh.com/1.0//sms/sms-aa1-1/outgoing)                            {                                "tag": "MojaKampania"                            }                    

Pamiętaj, że metoda https://api.ovh.com/1.0/sms/sms-aa1-1/jobs nie zwróci w tym trybie ID SMS-ów. Wysyłka zostanie przeprowadzona w sposób asynchroniczny.