Dodatki

Raporty doręczenia

Oprogramowanie SMSEagle pozwala włączyć raporty doręczenia dla każdego wysłanego SMS-a. Raporty doręczenia to funkcja, która umożliwia otrzymanie potwierdzenia, że SMS został odebrany na telefonie odbiorcy.

Aby włączyć raporty doręczenia, przejdź do web-GUI > menu Settings i ustaw „Delivery Reports” na „Yes”

Po włączeniu raportów doręczenia w web-GUI, możesz zweryfikować, czy SMS został doręczony do odbiorcy:

W web-GUI W menu Folders > Sent items > otwórz wiadomość, którą chcesz sprawdzić. Naciśnij „Show Details“ w prawym górnym rogu wiadomości. Pole „Modem Status” zawiera informacje o statusie doręczenia

Przy użyciu Callback URL Funkcja CallbackURL pozwala zdefiniować webhook dla zmiany statusu doręczenia. Webhooki to standardowe punkty końcowe HTTP zaimplementowane w Twojej zewnętrznej aplikacji, które będą przyjmować żądania HTTP od urządzenia SMSEagle. Webhooki uwalniają Cię od konieczności ciągłego wysyłania żądań do urządzenia SMSEagle w celu sprawdzenia statusu wiadomości. Więcej szczegółów znajdziesz w rozdziale Callback URL niniejszego Podręcznika Użytkownika.
Przy użyciu API

Użyj metody „read_sms”, aby pobrać dane dla wybranego SMS-a w folderze sentitems. Dane będą zawierać kolumny „Status” i „DeliveryDateTime”, które zawierają informacje o statusie doręczenia wiadomości. Więcej informacji o możliwych wartościach kolumny „Status” znajdziesz w tabeli „Field Description Of Response Data – Sentitems Folder” w APIv1 Reference.

Łączenie się bezpośrednio z bazą danych SMSEagle

Baza danych SMSEagle działa na silniku bazy danych PostgreSQL. Możesz skorzystać z bezpośredniego dostępu do bazy danych w celu odczytu/zapisu wiadomości SMS bezpośrednio z/do bazy danych za pomocą zapytań SQL.

Dostęp do bazy danych dla aplikacji zewnętrznych jest domyślnie wyłączony. Aby go włączyć, przejdź do webGUI > menu Settings i włącz następujące ustawienie:

Po włączeniu dostępu do bazy danych możliwe jest połączenie się z bazą danych z aplikacji zewnętrznej za pomocą następujących danych uwierzytelniających:

Host: adres IP Twojego urządzenia
Nazwa bazy danych: smseagle
Użytkownik: smseagleuser
Hasło: postgreeagle

Wstawianie krótkiego SMS-a za pomocą SQL

Najprostszym przykładem jest krótka wiadomość tekstowa (ograniczona do 160 znaków):

INSERT INTO outbox (
    DestinationNumber,
    TextDecoded,
    CreatorID,
    Coding,
    Class,
    SenderID
) VALUES (
    '1234567',
    'This is a SQL test message',
    'Program',
    'Default_No_Compression',
    -1,
    'smseagle1'
);
INSERT INTO user_outbox (
    id_outbox,
    id_user
) SELECT CURRVAL(pg_get_serial_sequence('outbox','ID')), 1;

W powyższym przykładzie wiadomość będzie należeć do użytkownika o id_user 1 (domyślnie «admin»). Wartości id_user dla innych użytkowników znajdziesz w tabeli public.”user”. Pole SenderID zawiera numer identyfikacyjny modemu SMSEagle. Dla modemu 1 SenderID = smseagle1, SenderID = smseagle2 dla modemu 2, itd.

Wstawianie długiego SMS-a za pomocą SQL

Wstawianie wiadomości wieloczęściowych jest trochę bardziej skomplikowane, musisz również skonstruować nagłówek UDH i zapisać go w formie zapisu szesnastkowego w polu UDH. Jeśli nie masz dobrego powodu, aby robić to ręcznie, użyj API.

Dla długiej wiadomości tekstowej UDH zaczyna się od 050003, po którym następuje bajt jako referencja wiadomości (możesz umieścić tam dowolną wartość szesnastkową, ale powinna być różna dla każdej wiadomości, D3 w poniższym przykładzie), bajt liczby wiadomości (02 w przykładzie, powinien być unikalny dla każdej wiadomości wysyłanej do tego samego numeru telefonu) oraz bajt numeru aktualnej wiadomości (01 dla pierwszej wiadomości, 02 dla drugiej, itd.).

Na przykład, długa wiadomość tekstowa złożona z dwóch części może wyglądać następująco:

INSERT INTO outbox (
    "DestinationNumber",
    "CreatorID",
    "MultiPart",
    "UDH",
    "TextDecoded",
    "Coding",
    "Class",
    "SenderID"
) VALUES (
    '1234567',
    'Program',
    'true',
    '050003D30201',
    'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, qui',
    'Default_No_Compression',
    -1,
    'smseagle1'
)
INSERT INTO outbox_multipart (
    "ID",
    "SequencePosition",
    "UDH",
    "TextDecoded",
    "Coding",
    "Class"
) SELECT
    CURRVAL(pg_get_serial_sequence('outbox','ID')),
    2,
    '050003D30202',
    's nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.',
    'Default_No_Compression',
    -1;
INSERT INTO user_outbox (
    id_outbox,
    id_user
) SELECT
    CURRVAL(pg_get_serial_sequence('outbox','ID')),
    1;

Uwaga: Dodanie UDH oznacza, że masz mniej miejsca na tekst, w powyższym przykładzie możesz użyć tylko 153 znaków w jednej wiadomości.

Skrypty czyszczenia bazy danych

Dodaliśmy kilka przydatnych skryptów, które mogą być używane do usuwania wiadomości SMS z bazy danych za pomocą Linux CLI. Skrypty znajdują się w następującym katalogu: /opt/scripts/

db_delete – skrypt do usuwania SMS-ów z folderów Inbox, SentItems starszych niż podana data. Użycie: ./db_delete YYYYMMDDhhmm
db_delete_7days – skrypt do usuwania SMS-ów z folderów Inbox, Sentitems starszych niż 7 dni. Użycie: ./db_delete_7days
db_delete_allfolders – skrypt do czyszczenia folderów bazy danych PostgreSQL (Inbox, SentItems, Outbox). Specjalnie zaprojektowany do okresowego uruchamiania przez cron. Użycie: ./db_delete_allfolders
db_delete_select - skrypt do usuwania SMS-ów z wybranego folderu bazy danych (Inbox, Outbox, SentItems, Trash). Użycie: ./db_delete_select {inbox|outbox|sentitems|trash}

Dodawanie skryptu do demona systemowego cron

Utwórz plik wewnątrz katalogu /etc/cron.d/ o dowolnej nazwie (np. pico db_cleaner)

Przykładowa zawartość tego pliku: 0 0 1 * * root /opt/scripts/db_delete_allfolders

Spowoduje to uruchamianie skryptu czyszczącego każdego 1^go dnia miesiąca.

Agent SNMP

„Simple Network Management Protocol (SNMP) to internetowy standard protokołu do zarządzania urządzeniami w sieciach IP. Jest wykorzystywany głównie w systemach zarządzania siecią do monitorowania urządzeń podłączonych do sieci pod kątem stanów wymagających uwagi administracyjnej” (źródło: Wikipedia).

Urządzenie SMSEagle posiada wbudowanego agenta Net-SNMP. Agent SNMP zapewnia dostęp do drzewa Linux Host MIB urządzenia, a dodatkowo (za pomocą rozszerzenia NET-SNMP-EXTEND-MIB) umożliwia dostęp do niestandardowych metryk specyficznych dla SMSEagle.

Dostępne metryki SNMP opisujące stan urządzenia SMSEagle to:

Nazwa metryki	Opis	OID
GSM_Signal1	Zwraca siłę sygnału 3G/4G w procentach dla modemu 1. Zakres wartości: 0-100. Jeśli modem jest odłączony od sieci komórkowej, GSM_Signal zwraca 0.	.1.3.6.1.4.1.8072.1.3.2.3.1.2.11.71.83.77.95.83.105.103.110.97.108.49
GSM_Signal[X]	Zwraca siłę sygnału 3G/4G w procentach dla modemu X. Zakres wartości: 0-100. Jeśli modem jest odłączony od sieci komórkowej, GSM_Signal zwraca 0.	.1.3.6.1.4.1.8072.1.3.2.3.1.2.11.71.83.77.95.83.105.103.110.97.108.[48+X]
GSM_NetName1	Zwraca nazwę sieci komórkowej na modemie 1	.1.3.6.1.4.1.8072.1.3.2.3.1.2.12.71.83.77.95.78.101.116.78.97.109.101.49
GSM_NetName[X]	Zwraca nazwę sieci komórkowej używanej na modemie X	.1.3.6.1.4.1.8072.1.3.2.3.1.2.12.71.83.77.95.78.101.116.78.97.109.101.[48+X]
GSM_ModemState[X] gdzie X to numer modemu	Zwraca informację o stanie modemu enabled/disabled	.1.3.6.1.4.1.8072.1.3.2.3.1.2.11.77.111.100.101.109.83.116.97.116.101.49 (dla 1. modemu) .1.3.6.1.4.1.8072.1.3.2.3.1.2.11.77.111.100.101.109.83.116.97.116.101.50 (dla 2. modemu) Itd.
FolderOutbox_Total	Zwraca liczbę wiadomości SMS w folderze Outbox (długość kolejki wychodzącej)	.1.3.6.1.4.1.8072.1.3.2.3.1.2.18.70.111.108.100.101.114.79.117.116.98.111.120.95.84.111.116.97.108
FolderInbox_Total	Zwraca liczbę wiadomości SMS w folderze Inbox	.1.3.6.1.4.1.8072.1.3.2.3.1.2.17.70.111.108.100.101.114.73.110.98.111.120.95.84.111.116.97.108
FolderSent_Last24H	Zwraca liczbę wiadomości SMS wysłanych z urządzenia w ciągu ostatnich 24 godzin	.1.3.6.1.4.1.8072.1.3.2.3.1.2.18.70.111.108.100.101.114.83.101.110.116.95.76.97.115.116.50.52.72
FolderSent_Last1M	Zwraca liczbę wiadomości SMS wysłanych z urządzenia w ciągu ostatniego miesiąca	.1.3.6.1.4.1.8072.1.3.2.3.1.2.17.70.111.108.100.101.114.83.101.110.116.95.76.97.115.116.49.77
FolderSent_Last24HSendErr	Zwraca liczbę wiadomości SMS wysłanych z błędem w ciągu ostatnich 24h. Błąd występuje, gdy modem 3G nie może wysłać wiadomości SMS lub wiadomość zostanie odrzucona przez operatora 3G/4G (najczęściej zdarza się, gdy środki na karcie SIM typu pre-paid się skończą)	.1.3.6.1.4.1.8072.1.3.2.3.1.2.25.70.111.108.100.101.114.83.101.110.116.95.76.97.115.116.50.52.72.83.101.110.100.69.114.114
SIM_State[X] gdzie X to numer modemu	Zwraca informację o fizycznym stanie karty SIM	.1.3.6.1.4.1.8072.1.3.2.3.1.2.10.83.73.77.95.83.116.97.116.101.49 (dla 1. modemu) .1.3.6.1.4.1.8072.1.3.2.3.1.2.10.83.73.77.95.83.116.97.116.101.50 (dla 2. modemu) Itd.
SIM_RegState[X] gdzie X to numer modemu	Zwraca informację o stanie rejestracji karty SIM w sieci komórkowej.	.1.3.6.1.4.1.8072.1.3.2.3.1.2.13.83.73.77.95.82.101.103.83.116.97.116.101.49 (dla 1. modemu) .1.3.6.1.4.1.8072.1.3.2.3.1.2.13.83.73.77.95.82.101.103.83.116.97.116.101.50 (dla 2. modemu) Itd.

Wartości wyników

Za pomocą OID

Wartości wyników dla każdej niestandardowej metryki są dostępne i można je pobrać z OID podanego w tabeli powyżej.

Za pomocą nazwy tekstowej

Alternatywnie, wartości wyników dla każdej niestandardowej metryki można pobrać, używając nazw tekstowych z drzewa OID pod: NET-SNMP-EXTEND-MIB::nsExtendOutputFull.”[NAZWA METRYKI]”

Na przykład: Wartość wyniku dla parametru GSM_Signal1: NET-SNMP-EXTEND-MIB::nsExtendOutputFull.”GSM_Signal1”

Jeśli wybrane przez Ciebie narzędzie SNMP nie może uzyskać dostępu do obiektów NET-SNMP-EXTEND-MIB, możesz pobrać definicje MIB z: https://www.smseagle.eu/download/NET-SNMP-EXTEND-MIB.txt

Odczyt wartości wyników Aby przetestować odczyt wartości parametrów z agenta SNMP, możesz użyć dowolnych narzędzi dostępnych dla protokołu SNMP (na przykład: biblioteki NET-SNMP dla systemu Linux lub iReasoning MiB-Browser dla systemu Windows).