Sådan konfigurerer du Dropbox Fax API

Opdateret Sep 22, 2025

In this article

person icon

Oplysningerne i denne artikel er relevante for kunder med betalte Dropbox Fax-planer.

Bemærk: Dropbox Fax-endepunkterne er ændret fra v1 til v3. v1-slutpunkterne vil ikke længere blive vedligeholdt. Få mere at vide om migreringen til de nye v3-slutpunkter og fordelene for udviklere.

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:
curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]"
Et eksempel på dette kunne være:
curl -u "myemail@hellofax.com:fakepassword" 
        "https://api.hellofax.com/v1/Accounts/15da1c48b10c96a903eb1bac3d592fbed24ebc35"
Et andet eksempel (husk at konvertere URL'en til et andet format):
curl "https://myemail%40hellofax.com:fakepassword%40api.hellofax.com/v1/Accounts/15da1c48b10c96a903eb1bac3d592fbed24ebc35"

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

  1. Sådan tilføjer du callback-webadresser til dine indgående og udgående faxer igen med en POST:
curl -u"[your username]:[your password]" \
     -d "DefaultInboundFaxCallbackUrl=https://www.example.com/inboundFax" \
     -d "DefaultOutboundFaxCallbackUrl=https://www.example.com/outboundFax" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]"
highlighter icon

Bemærk: Indgående faxer bliver POST'et til din callback-webadresse, så du behøver ikke at hente dem separat.

  1. Sådan gennemgår du de tilgængelige faxlinjer:
curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/FaxLines"

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

  1. 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:
curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/AreaCodes?StateCode=CA"
  1. Køb et faxnummer fra et af de tilgængelige områdenumre i trin 6:
curl -u "[your username]:[your password]" \
     -d "AreaCode=[area code from step 7]" \ 
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/FaxLines"
  1. Sådan sender du en fax:
curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions?To=[destination phone number]" \ 
     -F "file=@myfile.pdf"

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:
curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions?To=[destination phone number]&From=[your fax line phone number]" \
     -F file=@myfile.pdf`

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":
curl -u "[your username]:[your password]" \
     -F file[]="@1.pdf" -F file[]="@2.txt" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions?To=[phone number in all digits]"
eller
curl -X POST https://[your username]:[your password]@api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions -F 'file[0]=@file1.pdf' \
     -F 'file[1]=@file2.pdf' \
     -F 'To[0]=[destination fax number 0]' \
     -F 'To[1]=[destination fax number 1]'
  • 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:
Error sending fax. Status: 429; Message: Please wait. You already have at least 200 transmissions that are currently pending or transmitting.

Hvordan tjekker du statusser for faxer?

curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions/[Transmission GUID]"
  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:
curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions"
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.
highlighter icon

Bemærk!

  • For de faxer, der sendes via API'en, modtager du ikke en bekræftelse via e-mail.
  • For modtagne faxer gælder det, at du muligvis modtager en meddelelsesmail på baggrund af dine indstillinger for meddelelser.

  1. 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.

  1. 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.
  2. Angiv de FaxLines, du har købt:
curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Account GUID]/FaxLines"
  1. 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):
curl -u "[your username]:[your password]" 
     -X DELETE "https://api.hellofax.com/v1/Accounts/[Account GUID]/FaxLines/2132935579"
Hvis handlingen gennemføres, får du et svar 200.
highlighter icon

Bemærk: Der findes et velkendt problem, hvor JSON i callbacks indeholder en "transaktion" i stedet for en "transmission". Dette er en tastefejl, som bliver rettet i API'ens næste version.

Hjalp denne artikel?

Fortæl os, hvorfor den ikke hjalp:

Tak, fordi du fortæller os det!

Tak for din feedback!

Svar fra community

Andre måder, du kan få hjælp på