Sådan konfigurerer du Dropbox Fax API

Denne artikel indeholder oplysninger om, hvordan du konfigurerer Dropbox Fax API ved hjælp af v1-slutpunkterne, sikrer, at den fungerer, og køber yderligere faxlinjer, hvis det er nødvendigt.

Sådan konfigurerer du Dropbox Fax API ved hjælp af v1-slutpunkterne

Sådan kommer du i gang med at bruge v1-slutpunkterne:

1. Send en e-mail til support@hellosign.com med den e-mailadresse, du ønsker at bruge til din Dropbox Fax-konto. Du får et svar, når din Dropbox Fax API-adgang er aktiveret. Få mere at vide om priserne på Dropbox Fax API.
2. Log på din Dropbox Fax-konto. Skriv din kontos GUID ned, eftersom du skal bruge den til de fleste API-anmodninger (eller endepunkter).
3. Udfør din første API-anmodning, og få din kontos konfigurationsoplysninger:

Et eksempel på dette kunne være:

Et andet eksempel (husk at konvertere URL'en til et andet format):

Svaret vil være en JSON-gengivelse af dine kontoindstillinger.

4. Sådan tilføjer du callback-webadresser til dine indgående og udgående faxer igen med en POST:

5. Sådan gennemgår du de tilgængelige faxlinjer:

Svaret vil omfatte den FaxLine, du valgte, da du tilmeldte dig et premium-abonnement.

6. For at købe et faxnummer skal vi tjekke, hvilke områdenumre der er tilgængelige (ikke alle områdenumre er tilgængelige) med en GET:

7. Køb et faxnummer fra et af de tilgængelige områdenumre i trin 6:

8. Sådan sender du en fax:

Dette indleder afsendelsen af faxen. Modtagelse af et 200 HTTP-svar garanterer ikke, at faxen går igennem, eftersom der kan opstå en filkonverteringsfejl. Så snart faxens StatusCode ændres til E (for fejl (error)) eller S (for succes (success)), modtager du imidlertid en POST til den callback-webadresse, du angav i trin 4. Få mere at vide om callback-hændelser.

Mulige StatusCode-værdier:

• T = overfører/sender (transmitting/sending).
• P = afventer/konverterer (pending/converting).
• S = Er blevet sendt (successfully sent).
• E = fejl (error) Kunne ikke konvertere eller sende hele faxen.
• H = sat på pause (on hold). Denne fejl forekommer, hvis du har en ubekræftet konto, eller hvis du er løbet tør for faxsider uden at have et månedligt abonnement.

Mulige fejlkodeoplysninger (der henvises kun til dem, når StatusCode er angivet til E):

• B = Modtog signal om, at nummeret er optaget (busy).
• N = Svarer ikke (no answer).
• A = Ikke-tildelt nummer (Unallocated number) (betyder normalt, at det er blevet afbrudt).
• D = Linjen er afbrudt eller utilgængelig (disconnected or unreachable).
• L = Dette nummer er på listen over afviste numre (denied list) (bør ikke ske for noget amerikansk nummer).
• U = Ukendt fejl (unknown error). Det sker som regel, når en person besvarer opkaldet, eller når der er sket en fejl under faxoverførslen.
  

Bemærk!

• Hvis du sender en fax, og modtagerens faxmaskine understøtter identificering af abonnenten (CSID), vises dit primære faxnummer eller det faxnummer, du angiver i parameteren "Fra", på modtagerens faxdisplay. Dit primære faxnummer fremgår af selve faxen. Hvis du har flere Dropbox Fax-linjer, kan du vælge, hvilken faxmaskine der skal bruges som afsenderenhed ved at medtage parameteren "Fra" i webadressen, for eksempel:

For at se formatet på "Fra"-oplysningen skal du aflæse feltet "Nummer", der returneres ved opkald/af FaxLines (se trin 5 ovenfor).

• Du kan uploade flere filer og sende flere faxer under ét opkald – lav blot parameterarrays for "fil" og/eller "til":

eller

• Du kan tilføje en forside, der er genereret af Dropbox Fax, ved at angive en eller flere af følgende parametre: CoverPageTo, CoverPageFrom og CoverPageMessage.
• De faxer, der sendes via API'en, gemmes ikke på vores servere, når faxen er blevet sendt – de fjernes. Derfor kan du ikke se dem i brugerfladen. Indgående faxer, der er blevet POST'et til dit callback, gemmes dog på vores servere og kan ses på skærmen dine "dokumenter".
• Den øvre grænse for afventende faxer er 200 per dag. Hvis du når denne øvre grænse, får du vist fejl 429:

Hvordan tjekker du statusser for faxer?

1. Du kan finde overførslens GUID i det JSON-svar, der returneres fra API-opkaldet i trin 8. Derudover kan du tjekke status for alle dine overførsler ved at udelade overførslens GUID:

Disse resultater vises på en side. Disse resultater vises på en side. Du kan få forskellige sider ved at angive URL-parametrene Page og PageSize. Se svarelementerne FirstPageUri, NextPageUri, PreviousPageUri og LastPageUri for at se, hvordan sidevisninger fungerer.

2. Når faxens statuskode er angivet til S eller E, skal du tjekke, at din callback-webadressen for udgående fax blev udløst. Den bør modtage en POST med en parameter med navnet "json", som indeholder alt det, du ville få som svar på et opkald (se trin 1).

Hvis et vellykket POST-callback forhindres af et server- eller netværksproblem, forsøger Dropbox igen med disse intervaller:

• 15 minutter
• 45 minutter
• 1 time og 30 minutter
• 2 timer og 45 minutter
• 4 timer
• 8 timer og 15 minutter
• 16 timer og 30 minutter

Ved hvert interval kan Dropbox forsøge POST'en flere gange, hvis svarkode 200 ikke modtages.

3. Hvis du sendte faxen til dit eget Dropbox Fax-nummer (nyttigt til test), skal du tjekke, at din callback-webadresse til indgående fax også blev udløst.
4. Angiv de FaxLines, du har købt:

5. For at slette en FaxLine skal du foretage et DELETE-opkald til den pågældende FaxLines webadresse (angivet i svaret på det foregående trin):

Hvis handlingen gennemføres, får du et svar 200.