Wybierz istniejącą markę na swoim koncie
Zacznij od identyfikatora marki w rejestrze, który jest już powiązany z Twoim kontem MultiTEL. To zapytanie nie tworzy marki ani nie przypisuje do Twojego konta cudzej marki. Obecny proces obsługi klienta sprawdza przynależność marki do konta przed pobraniem informacji o dopuszczonych zastosowaniach. Jeśli zapytanie zwróci 404, sprawdź wybrane konto i markę, zamiast podstawiać lokalny identyfikator wiersza.
Utwórz listę zastosowań do wyboru na podstawie tego wyniku
Ogólny katalog zastosowań opisuje opcje dostępne w rejestrze. To zapytanie dotyczące konkretnej marki dostarcza opcje dla wybranej marki. Zachowaj każdą zwróconą wartość pola usecase i połącz ją z etykietą wyświetlaną oraz opisem z katalogu. Nie udostępniaj wszystkich pozycji ogólnego katalogu tak, jakby marka kwalifikowała się do każdej z nich.
Portal oczekuje odpowiedzi w postaci listy JSON. Jeśli odpowiedzi brakuje, ma ona nieprawidłowy format lub jest błędem, zachowaj dane formularza klienta i wyświetl informację, że nie udało się wczytać dopuszczonych zastosowań. Nie traktuj tego po cichu jako zatwierdzenia domyślnego zastosowania. Rejestr może zwrócić pola niewidoczne w skróconym przykładzie.
Wczytaj wymagania dla wybranego zastosowania
Gdy klient wybierze jedną ze zwróconych wartości zastosowania, wyślij żądanie do /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} dla tej samej marki. Ta odpowiedź określa limity dotyczące zastosowań podrzędnych i wymagania poszczególnych operatorów. Wykorzystaj ją do zebrania przykładowych wiadomości, zgód i innych wymaganych oświadczeń. Sama lista dopuszczonych zastosowań nie wystarcza do przygotowania kompletnego zgłoszenia rejestracji kampanii.
Sprawdź ceny dla konta osobno
Pola dostawcy, takie jak monthlyFee, quarterlyFee lub annualFee, jeśli zostaną zwrócone, opisują metadane opłat dostawcy. Nie zastępują cen obowiązujących na koncie klienta ani warunków rejestracji. Obecny portal odczytuje ceny detaliczne kampanii osobno i łączy je z danymi o dopuszczonych zastosowaniach na ekranie przeglądu. Nie ustalaj opłaty dla klienta na podstawie cen zapisanych na stałe w starej funkcji pomocniczej obsługującej typ wyliczeniowy.
Odśwież dane po zmianie marki lub zastosowania
Po zmianie marki odrzuć opcje poprzedniej marki i wczytaj dopuszczone zastosowania dla nowego wyboru. Przed wysłaniem zgłoszenia odśwież wymagania wybranego zastosowania. Te żądania GET nie zgłaszają rejestracji, nie aktywują kampanii ani nie przypisują numerów.
Żądanie
Użyj aktywnego konta API przez HTTPS z dozwolonego źródłowego adresu IP. Obecna ścieżka obsługuje zasady uwierzytelniania konta, w tym uwierzytelnianie Basic oraz aktywne konta API z uwierzytelnianiem tokenem Bearer. Nie używaj danych uwierzytelniających dostawcy.
GET z identyfikatorem marki w ścieżce URL. Treść żądania nie jest wymagana.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Nazwa | Typ | Wymagany | Opis |
|---|---|---|---|
brand_id | ciąg znaków | Tak | Identyfikator marki w rejestrze powiązany z Twoim uwierzytelnionym kontem MultiTEL. Użyj identyfikatora marki, a nie lokalnego identyfikatora wiersza bazy danych, identyfikatora kampanii ani numeru podatkowego firmy. Zakoduj go jako pojedynczy segment ścieżki URL. |
Odpowiedź
Obecna ścieżka TCR zwraca bezpośrednio treść JSON z rejestru i zachowuje jej status HTTP. Nie dodaje starszej otoczki status/response z wersji v3. Skrócony, fikcyjny przykład nie jest rzeczywistym wynikiem sprawdzenia dopuszczonych zastosowań. Przed użyciem odpowiedzi sprawdź status HTTP i oczekiwaną strukturę JSON. Obecny portal oczekuje listy rekordów dopuszczonych zastosowań, z których każdy wskazuje usecase. Łączy te rekordy z katalogiem usecase, aby uzyskać etykiety do wyświetlenia, a ceny detaliczne odczytuje osobno. Mogą występować dodatkowe pola dostawcy.
Przykładowa struktura odpowiedzi; nie przedstawia rzeczywistych danych konta ani aktualnej oferty cenowej.
[
{
"usecase": "2FA"
}
]Błędy
- 401: Uwierzytelnienie konta nie powiodło się. Sprawdź dane uwierzytelniające API, stan aktywacji konta oraz obowiązujące ograniczenia źródłowych adresów IP.
- 404: Marka nie jest powiązana z uwierzytelnionym kontem albo dostawca nie może znaleźć żądanej marki lub wybranej opcji. Lokalna odmowa wynikająca z braku przynależności marki do konta jest zwracana przed wysłaniem żądania do dostawcy.
- Inne błędy rejestru: Status HTTP i treść odpowiedzi usługi nadrzędnej zostają zachowane. Nieprawidłowe lub niedostępne zastosowanie nie oznacza pomyślnego zwrócenia pustego zestawu wymagań.
- 429: Osiągnięto limit żądań konta lub współdzielony limit żądań dostawcy. Przestrzegaj Retry-After.
- 502/503: Błąd transportu lub niedostępność dostawcy albo mechanizmu ograniczania liczby żądań. Zachowaj dane formularza i ponów próbę ze zwiększanym odstępem między próbami.
Dostępność i skutki uboczne
- Sprawdzone żądanie GET weryfikuje przynależność istniejącej marki do konta, kontaktuje się z rejestrem i zapisuje wpisy audytowe żądania. Nie tworzy marki ani kampanii i nie nalicza opłaty rejestracyjnej.
- Metadane opłat dostawcy nie są ofertą cen detalicznych dla klienta MultiTEL. Portal sprawdza ceny dla konta osobno przed późniejszym żądaniem rejestracji.
- Dopuszczone zastosowania i wymagania mogą się zmieniać. Odśwież je dla wybranej marki i zastosowania przed wysłaniem zgłoszenia. Pomyślne zapytanie nie oznacza zatwierdzenia kampanii, przypisania numerów ani zgody na rozpoczęcie wysyłania wiadomości.