Slik konfigurerer du Dropbox Fax API

Denne artikkelen inneholder informasjon om hvordan du konfigurerer Dropbox Fax API ved hjelp av v1-endepunktene, kontrollerer at den fungerer, og kjøper om nødvendig flere fakslinjer.

Konfigurere Dropbox Fax API ved hjelp av v1-endepunktene

Slik kommer du i gang med v1-endepunktene:

1. Send en e-post til support@hellosign.com som inneholder e-postadressen du vil bruke med Dropbox Fax-kontoen. Du får svar når tilgangen til Dropbox Fax API er aktivert. Finn ut mer om Dropbox Fax API-priser.
2. Logg på Dropbox Fax-kontoen. Noter deg kontoens GUID, ettersom du trenger denne for de fleste API-forespørsler (eller endepunkter).
3. Opprett din første API-forespørsel og få kontoens konfigurasjonsinformasjon:

Et eksempel på dette kan være:

Et annet eksempel (husk å kode URL-adressen):

Responsen vil være en JSON-representasjon av kontoinnstillingene.

4. Slik legger du til URL-adresser for tilbakekalling for innkommende og utgående fakser på nytt med en POST-forespørsel:

5. Slik ser du gjennom de tilgjengelige fakslinjene:

Svaret inkluderer fakslinjen du valgte da du registrerte deg for et premium-abonnement.

6. For å kjøpe et faksnummer, må vi sjekke hvilke retningsnumre som er tilgjengelige (ikke alle retningsnumre er tilgjengelige) med en GET-forespørsel:

7. Kjøp et faksnummer fra et av de tilgjengelige retningsnumrene i trinn 6:

8. Slik sender du en faks:

Dette starter fakssendingsprosessen. Mottak av en 200 HTTP-respons garanterer ikke at faksen går gjennom. En filkonverteringsfeil kan oppstå. Men når faksens statuskode blir E (for Error) eller S (for Success), mottar du en POST-forespørsel til URL-adressen for tilbakekalling du oppgav i trinn 4. Finn ut mer om tilbakekallingsshendelser.

Mulige statuskodeverdier:

• T = Sender (Transmitting/sending).
• P = Venter/konverterer (Pending/converting).
• S = Sendt (Successfully sent).
• E = Feil (Error). Kunne ikke konvertere eller sende fullstendig.
• H = På vent (On hold). Denne feilen oppstår hvis du har en ubekreftet konto, eller hvis du er tom for fakssider uten et månedlig abonnement.

Mulige feilkodeverdier (bare når statuskoden er satt til E):

• B = Opptattsignal mottatt (Received a busy signal).
• N = Ikke noe svar (No answer).
• A = Fraordnet nummer - betyr vanligvis at det er frakoblet (Unallocated number).
• D = Linjen er frakoblet eller utilgjengelig (Disconnected).
• L = Dette nummeret er på listen over avslag (bør ikke skje for amerikanske numre).
• U = Ukjent feil (Unknown error). Dette skjer vanligvis når en person svarer, eller det oppstod en feil under faksoverføringen.
  

Merknader:

• Hvis du sender en faks og mottakerens faksmaskin støtter lesing, kalt abonnentidentifikasjon (CSID), viser anroper-ID-en ditt primære faksnummer, eller faksnummeret du angir i parameteren «From». Husk at det primære faksnummeret vises på selve faksen. Hvis du har flere Dropbox Fax-linjer, kan du velge hvilken som brukes som sender ved å inkludere parameteren «From» i URL-adressen, for eksempel:

Hvis du vil vise formatet for verdien «From», kan du se «Number»-feltet ved å kalle /FaxLines (se trinn 5 ovenfor).

• Du kan laste opp flere filer og sende flere fakser i ett kall. Det er bare å gjøre parameterne «file» og/eller «To» til matriser:

eller

• Du kan legge til en Dropbox Fax-generert forside ved å angi én eller flere av følgende parametere: CoverPageTo, CoverPageFrom og CoverPageMessage.
• Fakser som ble sendt av API-et, lagres ikke på serverne våre når faksen er sendt. De blir i stedet fjernet. Derfor vises de ikke i brukergrensesnittet. Innkommende fakser som ble POST-et i tilbakekallingen, blir lagret på serverne våre og er tilgjengelige for visning på skjermen «Dokumenter».
• Det er en grense på 200 ventende fakser per dag. Hvis du når denne grensen, vises det en 429-feil:

Hvordan sjekke faksstatuser?

1. Du kan finne GUID-en for overføring i JSON-responsen som ble returnert fra API-kallet i trinn 8. I tillegg kan du kontrollere statusen for alle overføringene dine ved å utelate GUID-en for overføring:

Disse resultatene er paginerte (paged). Du kan få forskjellige sider ved å angi Page- og PageSize URL-parameterne. Se responselementene FirstPageUri, NextPageUri, PreviousPageUri og LastPageUri for hvordan paginering (paging) fungerer.

2. Når statuskoden for faksen er satt til S eller E, må du bekrefte at URL-adressen for tilbakekalling for utgående faks ble utløst. Den skal motta en POST-forespørsel med en parameter kalt «json», som inneholder alt du får som svar på et kall (se trinn 1).

Hvis en vellykket tilbakekalling av en POST-forespørsel hindres av et server- eller nettverksproblem, prøver Dropbox på nytt med disse intervallene:

• 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

I hvert intervall forsøker Dropbox kanskje POST-forespørselen flere ganger hvis responskoden 200 ikke blir mottatt.

3. Hvis du sendte faksen til ditt eget Dropbox Fax-nummer (nyttig for testing), må du bekrefte at URL-adressen for tilbakekalling for innkommende faks også ble utløst.
4. Oppgi fakslinjene du har kjøpt:

5. Hvis du vil slette en fakslinje, foretar du et DELETE-kall til fakslinjens URI (spesifisert i responsen i forrige trinn):

Hvis operasjonen er vellykket, vil du motta en responskode 200.