Jak skonfigurować Dropbox Fax-API

Ten artykuł zawiera informacje o tym, jak skonfigurować interfejs API Dropbox Fax przy użyciu punktów końcowych v1, upewnić się, że działa, i w razie potrzeby kupić dodatkowe linie faksu.

Jak skonfigurować interfejs API Dropbox Fax przy użyciu punktów końcowych v1

Aby rozpocząć korzystanie z punktów końcowych v1:

1. 1. Wyślij wiadomość e-mail na adres support@hellosign.com zawierającą adres e-mail, z którego chcesz korzystać na swoim koncie Dropbox Fax. Otrzymasz odpowiedź, gdy dostęp do interfejsu API Dropbox Fax zostanie włączony. Więcej informacji na temat opłat związanych z korzystaniem z interfejsu API Dropbox Fax.
2. Zaloguj się na swoje konto Dropbox Fax. Zanotuj identyfikator GUID swojego konta, ponieważ będzie on potrzebny w przypadku większości żądań API (lub punktów końcowych).
3. Wykonaj pierwsze żądanie API i odbierz dane do konfiguracji konta:

Może to być na przykład:

Inny przykład (pamiętaj o odpowiednim kodowaniu adresu URL):

Odpowiedź będzie reprezentacją ustawień konta w formacie JSON.

4. Aby ponownie dodać adresy URL wywołań zwrotnych dla faksów przychodzących i wychodzących za pomocą żądania POST:

5. Aby sprawdzić dostępne linie faksu:

Odpowiedź będzie zawierać FaxLine wybraną podczas rejestracji subskrypcji premium.

6. Aby kupić numer faksu, musimy sprawdzić, które stanowe numery kierunkowe są dostępne (nie wszystkie numery kierunkowe są dostępne) za pomocą żądania GET:

7. Kup numer faksu w ramach jednego z dostępnych numerów kierunkowych określonych w kroku 6.:

8. Aby wysłać faks:

Spowoduje to rozpoczęcie procesu wysyłania faksu. Otrzymanie odpowiedzi HTTP 200 nie gwarantuje, że faks przejdzie, może wystąpić błąd konwersji pliku. Jednak gdy StatusCode zmieni się na E (błąd) lub S (powodzenie), otrzymasz żądanie POST na adres URL wywołania zwrotnego podany w kroku 4. Więcej informacji o zdarzeniach wywołania zwrotnego.

Możliwe wartości StatusCode:

• T = Nadawanie/wysyłanie.
• P = Oczekiwanie/konwertowanie.
• S = Wysłano pomyślnie.
• E = Błąd. Nie udało się przekonwertować lub wysłać w całości.
• H = Wstrzymano. Ten błąd pojawia się, jeżeli Twoje konto jest niepotwierdzone, lub gdy wykorzystano wszystkie strony faksu dostępne bez zakupu miesięcznej subskrypcji.

Możliwe wartości ErrorCode (dotyczą sytuacji, gdy StatusCode jest ustawiony na E):

• B = Otrzymano sygnał zajętości.
• N = Brak odpowiedzi.
• A = Nieprzydzielony numer (zwykle oznacza, że został on odłączony).
• D = Linia jest odłączona lub nieosiągalna.
• L = Ten numer znajduje się na liście odrzuconych (nie powinno się to zdarzyć w przypadku żadnego numeru ze Stanów Zjednoczonych).
• U = Nieznany błąd. Zwykle ma to miejsce, gdy osoba podniesie słuchawkę lub gdy wystąpi błąd w trakcie przesyłania faksu.
  

Uwagi:

• Jeśli wyślesz faks, a urządzenie odbiorcy obsługuje identyfikację abonenta (CSID), wówczas jako identyfikator dzwoniącego zostanie wyświetlony Twój główny numer faksu lub numer faksu określony dla parametru „From”. Na samym faksie widnieć będzie Twój podstawowy numer faksu. Jeżeli masz wiele linii Dropbox Fax, możesz wybrać, która z nich będzie używana jako urządzenie wysyłające, dodając do adresu URL parametr „From”:

Format wartości „From” można sprawdzić w polu „Number” zwracanym przez wywołanie /FaxLines (patrz krok 5. powyżej).

• Możesz przesyłać wiele plików i wysyłać wiele faksów podczas jednego połączenia – wystarczy utworzyć tablice parametrów „file” lub „To”:

lub

• Możesz dodać stronę tytułową wygenerowaną przez Dropbox Fax, określając co najmniej jeden z następujących parametrów: CoverPageTo, CoverPageFrom i CoverPageMessage.
• Faksy wysłane przez interfejs API nie są przechowywane na naszych serwerach po ich pomyślnym wysłaniu – są one usuwane. W związku z tym nie można ich wyświetlić w interfejsie użytkownika. Jednak faksy przychodzące, przesłane pomyślnie za pomocą żądania POST do wywołania zwrotnego są przechowywane na naszych serwerach i można je wyświetlić na ekranie „Dokumenty”.
• Obowiązuje limit 200 oczekujących faksów dziennie. Po osiągnięciu tego limitu wystąpi błąd 429:

Jak sprawdzić statusy faksów?

1. Identyfikator GUID transmisji możesz znaleźć w odpowiedzi JSON zwróconej z wywołania API w kroku 8. Dodatkowo możesz sprawdzić status wszystkich swoich transmisji, pomijając identyfikator GUID transmisji:

Te wyniki są stronicowane. Możesz dostosować wygląd stron, określając w adresie URL parametry „Page” i „PageSize”. Aby dowiedzieć się, jak działa stronicowanie, zapoznaj się z elementami odpowiedzi „FirstPageUri”, „NextPageUri”, „PreviousPageUri” i „LastPageUri”.

2. Po ustawieniu kodu statusu faksu na S lub E, sprawdź, czy został uruchomiony adres URL wywołania zwrotnego faksu wychodzącego. Powinien on otrzymać żądanie POST z parametrem o nazwie „json”, który zawiera całość odpowiedzi na wywołanie (patrz krok 1.).

Jeżeli pomyślne wykonanie wywołania zwrotnego z żądaniem POST jest niemożliwe z powodu problemów z serwerem lub siecią, Dropbox będzie próbować wysłać je ponownie w następujących odstępach czasowych:

• 15 minut
• 45 minut
• 1 godzina i 30 minut
• 2 godziny i 45 minut
• 4 godziny
• 8 godzin i 15 minut
• 16 godzin i 30 minut

W każdym z tych odstępów czasowych Dropbox może podejmować wiele prób wysłania żądania POST, jeżeli w odpowiedzi nie zostanie zwrócony kod 200.

3. Jeżeli wysłano faks na własny numer Dropbox Fax (przydatne do testów), sprawdź, czy został również uruchomiony adres URL wywołania zwrotnego faksu przychodzącego.
4. Pokaż listę kupionych przez Ciebie FaxLines:

5. Aby usunąć FaxLine, wykonaj wywołanie DELETE do Uri tej FaxLine (określone w odpowiedzi na poprzedni krok):

Jeżeli operacja się powiedzie, otrzymasz odpowiedź 200.