API SMS

Odbiorca otrzyma SMS wysłany z krótkiego numeru o treści "Test message".
API zwróci liczbę wykorzystanych kredytów, prawidłowych i nieprawidłowych numerów telefonów odbiorców, a także identyfikatory SMS-ów pozwalające śledzić ich status.

1 - Aby zgłosić nowego nadawcę:

POST https://api.ovh.com/1.0/sms/sms-aa1-1/senders
{
    "reason":   "I own the company and need to send SMS to my customers",
    "sender":   "SMS inc."
}
                    

2 - Uruchomiony zostanie ręczny proces zatwierdzania.
Sprawdź etap zatwierdzenia w polu „status”:

GET https://api.ovh.com/1.0/sms/sms-aa1-1/senders/SMS inc.
                    

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

• waitingValidation: Trwa zatwierdzanie
• refused: odmowa zatwierdzenia (przyczynę możesz sprawdzić w polu „komentarz”).
• enable: włączony (możesz używać tej nazwy nadawcy)
• disable: wyłączony (nadawca jest tymczasowo wyłączony i możesz go ponownie aktywować w dowolnym momencie).

Po zatwierdzeniu nadawcy możesz wysyłać SMS-y, używając jego nazwy.

Możesz zaprogramować datę i godzinę wysyłki.

Skorzystaj z pola „differedPeriod”, aby wysłać SMS-a w późniejszym terminie. W podanym przykładzie wysyłka została przesunięta o 120 minut, zatem SMS zostanie wysłany dwie godziny później.

Status SMS-a możesz sprawdzić 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: Dostarczono
• 2: Wiadomość odrzucona lub niedostarczona z powodu zbyt długiego czasu niedostępności numeru
• 4: Oczekuje w sieci operatora odbiorcy
• 8: Przekazano do sieci operatora odbiorcy
• 16: Nie można dostarczyć wiadomości

Pole „ptt” zawiera dodatkowe informacje.

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

Dzięki rozwiązaniu OVHcloud będziesz otrzymywał powiadomienia w czasie rzeczywistym za pośrednictwem połączenia HTTP, gdy status wiadomości SMS się zmieni.

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

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

Po skonfigurowaniu powiadomień, przy każdej zmianie 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

Aby wygenerować zamówienie przez API OVHcloud:

Dzięki rozwiązaniu OVHcloud nie musisz się martwić o liczbę pozostałych na koncie kredytów.

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

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

Aby ustawić 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 zoptymalizować masową wysyłkę SMS-ów, możesz wstępnie załadować listę odbiorców do pliku CSV.

Aby utworzyć plik z listą odbiorców:

POST https://api.ovh.com/1.0/sms/sms-aa1-1/receivers
{
    "csvUrl":       "http://mywebsite.com/my_recipients.csv",
    "description":  "My customers list",
    "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
+33601020304;Heetfield;47
+33602030405;Uulrich;36
+33603040506;Haammett;39
                    

Aby wysłać SMS do wszystkich odbiorców z listy zawartej w pliku, zastosuj następujące wywołanie:

POST https://api.ovh.com/1.0/sms/sms-aa1-1/jobs
{
    "message":              "Hello, Mr #NAME#. You are #AGE# years old.",
    "receiversSlotId":      1,
    "senderForResponse":    true
    "tag": "MaCampagne"
}
                    

Dzięki temu wywołaniu wszyscy trzej odbiorcy otrzymają spersonalizowaną wiadomość.
Na przykład Michał otrzyma wiadomość: „Cześć Michał, 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": "MyCampain"
}
                    

Zauważ, że wywołanie https://api.ovh.com/1.0/sms/sms-aa1-1/jobs nie zwróci ID SMS-ów, ponieważ wysyłka zostanie zrealizowana w sposób asynchroniczny.

Aby poznać z wyprzedzeniem cenę wysyłki, zastosuj następujące wywołanie:

Dzięki wywołaniu podanemu w przykładzie otrzymasz cenę wysyłki 1 000 SMS-ów do Francji w walucie używanej w tym kraju (w tym przypadku euro).