Så här konfigurerar du Dropbox Fax API

Den här artikeln innehåller information om hur du konfigurerar Dropbox Fax API med hjälp av v1-slutpunkterna, ser till att det fungerar och köper ytterligare faxlinjer om det behövs.

Så här konfigurerar du Dropbox Fax API med v1-slutpunkterna

Så här kommer du igång med v1-slutpunkterna:

1. Skicka ett e-postmeddelande till support@hellosign.com med den mejladress du vill använda för ditt Dropbox Fax-konto. Du får ett svar när din Dropbox Fax API Access är aktiverad. Läs mer om Dropbox Fax API-priser.
2. Logga in på ditt Dropbox Fax-konto. Notera ditt konto-GUID eftersom du behöver detta för de flesta API-förfrågningar (eller slutpunkter).
3. Gör din första API-begäran och få ditt kontos konfigurationsinformation:

Ett exempel på detta skulle vara:

Ett annat exempel (kom ihåg att URL-koda):

Svaret kommer att vara en JSON-representation av dina kontoinställningar.

4. Så här lägger du till-URL:er för återanrop för dina inkommande och utgående fax igen med en POST:

5. Så här granskar du de tillgängliga faxlinjerna:

Svaret kommer att inkludera den faxlinje du valde när du registrerade dig för en premiumprenumeration.

6. För att köpa ett faxnummer måste vi kontrollera vilka riktnummer som finns tillgängliga (inte alla riktnummer finns tillgängliga) med en GET:

7. Köp ett faxnummer från ett av de tillgängliga riktnumren i steg 6:

8. Så här skickar du fax:

Detta startar faxsändningsprocessen. Att ta emot ett 200 HTTP-svar garanterar inte att faxet kommer att gå igenom, ett filkonverteringsfel kan uppstå. Men när faxets statuskod blir E (för fel) eller S (för lyckat) får du en POST till den återanrops-URL du angav i steg 4. Läs mer om återanropshändelser.

Möjliga statuskodvärden:

• T = Sänder/skickar.
• P = Väntande/konverterar.
• S = Har skickats.
• E = Fel. Det gick inte att konvertera eller skicka helt.
• H = I vänteläge. Detta fel uppstår om du har ett obekräftat konto eller om du har slut på faxsidor utan en månatlig prenumeration.

Möjliga felkodsvärden (referera endast när statuskod är inställd på E):

• B = Tog emot upptaget-signal.
• N = Inget svar.
• A = Otilldelat nummer (betyder vanligtvis att det har kopplats bort).
• D = Linjen är frånkopplad eller oåtkomlig.
• L = Detta nummer finns på den nekade listan (bör inte hända för något amerikanskt nummer).
• U = Okänt fel. Detta inträffar vanligtvis när en person plockar upp linjen eller ett fel uppstod under faxöverföringen.
  

Anmärkningar:

• Om du skickar ett fax och mottagarens faxmaskin stöder abonnentidentifiering (CSID), kommer nummerpresentationen att visa ditt primära faxnummer eller det faxnummer du anger i parametern "Från". Ditt primära faxnummer kommer att visas på själva faxet. Om du har flera Dropbox Fax-linjer kan du välja vilken du vill använda som sändande faxmaskin genom att inkludera parametern "Från" i URL:en:

För formatet för "Från"-värdet, se fältet "Nummer" som returneras genom att ringa /FaxLines (se steg 5 ovan).

• Du kan ladda upp flera filer och skicka flera fax i ett samtal – gör bara parameteruppsättningarna "file" och/eller "To":

eller

• Du kan lägga till en Dropbox Fax-genererad försättssida genom att ange en eller flera av följande parametrar: CoverPageTo, CoverPageFrom och CoverPageMessage.
• Fax som skickas av API lagras inte på våra servrar när faxet har skickats – de tas bort. Därför kan du inte se dem i UI. Inkommande fax som har POST:ats till ditt återanrop lagras dock på våra servrar och är tillgängliga för visning på din "dokument"-skärm.
• Det finns en gräns på 200 väntande fax per dag. Om du når denna gräns kommer du att stöta på ett 429-fel:

Hur kontrollerar jag faxstatus?

1. Du kan hitta överförings-GUID i JSON-svaret som returnerades från API-anropet i steg 8. Dessutom kan du kontrollera statusen för alla dina överföringar genom att utelämna överförings-GUID:

Dessa resultat är personsökta. Du kan få olika sidor genom att ange parametrarna Page och PageSize URL. Se svarselementen FirstPageUri, NextPageUri, PreviousPageUri och LastPageUri för information om hur personsökning fungerar.

2. När statuskoden för faxet är inställd på S eller E kontrollerar du att webbadressen för det utgående faxet har utlösts. Den bör få en POST med en parameter som heter "json" som innehåller allt du skulle få i svaret på ett samtal (se steg 1).

Om ett lyckat POST-återanrop förhindras av ett server- eller nätverksproblem kommer Dropbox att försöka igen med dessa intervall:

• 15 minuter
• 45 minuter
• 1 timme och 30 minuter
• 2 timmar och 45 minuter
• 4 timmar
• 8 timmar och 15 minuter
• 16 timmar och 30 minuter

Vid varje intervall kan Dropbox försöka göra POST flera gånger om en svarskod på 200 inte tas emot.

3. Om du skickade faxet till ditt eget Dropbox Fax-nummer (användbart för testning) ska du kontrollera att webbadressen för det inkommande faxet också utlöstes.
4. Lista de faxlinjer du har köpt:

5. För att radera en faxlinje, ring ett DELETE-anrop till den FaxLine-URI:n (som anges i svaret på föregående steg):

Om åtgärden lyckas får du ett 200-svar.