Pirms nosūtīšanas
Izmantojiet sūtītāja numuru, kuru jums ir tiesības norādīt, un sūtiet tikai saņēmējam, kurš gaida jūsu faksu. Šis pieprasījums izveido īstu sūtījumu, par kuru var tikt piemērota maksa. Lai lappušu noteikšana būtu pēc iespējas paredzamāka, izmantojiet iepriekš sagatavotu PDF vai TIFF dokumentu. Atbilde par ievietošanu rindā apstiprina pieņemšanu, nevis piegādi.
Izmantojiet iespējotu MultiTEL API kontu. Kontam ar paroli nosūtiet HTTP Basic autentifikācijas datus, bet kontam ar pilnvaru — Bearer pilnvaru. Joprojām ir spēkā konta atļaujas un IP ierobežojumi. Neizmantojiet iekšējā fona izpildītāja autentifikācijas datus.
Augšupielādējiet dokumentu
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--form-string from_number=+12125550123 \
--form-string to_number=+12125550124 \
--form fax_file=@./document.pdf \
https://api.multitel.net/v3/send_fax| Lauks | Obligāts | Nozīme |
|---|---|---|
from_number | Jā | Sūtītāja numurs, kuru jums ir tiesības norādīt. Izmantojiet starptautisko formātu, kas sākas ar + un valsts kodu. |
to_number | Jā | Saņēmēja faksa numurs starptautiskajā formātā. |
fax_file | Jā, vairāku daļu pieprasījumam | Augšupielādētais dokuments. Ļaujiet curl iestatīt vairāku daļu pieprasījuma Content-Type un daļu atdalītāju. |
webhook_url | Nē | Neobligāta HTTP vai HTTPS atzvana URL adrese; ieteicams izmantot HTTPS. Atzvana datu saturs un piegādes garantijas vēl tiek pārskatītas: periodiski pieprasiet fax_status, lai sekotu dokumentētajai statusa pārbaudes darbplūsmai. |
Tiek pieņemts arī JSON ar Content-Type: application/json, tiem pašiem numuru laukiem un neobligāto webhook_url, kā arī file_name un file_b64. file_b64 satur dokumenta baitus, kas kodēti, stingri ievērojot Base64 formātu, bez data: prefiksa. Derīgam vairāku daļu pieprasījuma laukam fax_file ir priekšroka. Šī nav API failu izgūšanai no URL adresēm.
Dokumentu un iesniegšanas ierobežojumi
Lietotne pieņem ne vairāk kā 15,728,640 dekodētus dokumenta baitus (15 MiB) ar paplašinājumiem pdf, tif, tiff, jpg, jpeg, png, doc, docx vai txt. Atļauts paplašinājums negarantē, ka pakalpojums spēs saskaitīt vai konvertēt lappuses. Infrastruktūras pieprasījumu ierobežojumi var būt zemāki, un Base64 palielina pieprasījuma izmēru.
Pašreizējā lietotne katram kontam atļauj vienu rindā esošu vai nosūtīšanas procesā esošu uzdevumu uz vienu un to pašu saņēmēja numuru, ne vairāk kā piecus iesniegumus uz šo numuru pēdējās stundas laikā un kopā ne vairāk kā 50 iesniegumus pēdējās stundas laikā. Atbildē par pieprasījumu biežuma ierobežojumu tiek izmantots API kods 429. Pirms atkārtota mēģinājuma nogaidiet; nemēģiniet apiet ierobežojumus.
Saglabājiet uzdevuma ID
Pārbaudiet gan HTTP rezultātu, gan JSON lauku status.code. JSON kļūdu atbildes var tikt saņemtas ar HTTP 200. Veiksmīga JSON atbilde satur status un response; piemēros izmantoti izdomāti dati.
{
"status": {
"code": 200,
"msg": "Fax queued"
},
"response": {
"job_id": "0123456789abcdef0123456789abcdef"
}
}Periodiski pieprasiet fax_status ar response.job_id. Ja nosūtīšanas atbilde ir pazudusi, pirms atkārtotas nosūtīšanas pārbaudiet portāla izejošo sūtījumu mapi: atkārtoti pieprasījumi var izveidot atsevišķus sūtījumus. Šis apstrādātājs nenodrošina klientam pieejamu idempotences parametru.
Kļūdas un atlikuma pārbaudes
API kodi ietver 400, ja trūkst lauku, atzvana URL adrese nav derīga, dokuments ir noraidīts vai nav izdevies noteikt lappuses; 401, ja nav autentifikācijas; 402, ja faksa paredzamās izmaksas kopā ar rindā esošo un nosūtīšanas procesā esošo uzdevumu paredzamajām izmaksām pārsniedz pieejamo konta atlikumu; 429 pieprasījumu biežuma ierobežojumu gadījumā; un 500, ja neizdodas sagatavot sūtījumu apstrādei. Konkrēto iemeslu skatiet laukā status.msg.
Rindā pirms nosūtīšanas tiek reģistrētas paredzamās izmaksas. Neuztveriet pieņemšanu, atlikuma pārbaudi vai šo aplēsi kā apstiprinājumu tam, ka maksa jau ir iekasēta. Galīgā norēķinu kārtība un atzvanu informācija vēl ir jāpārbauda.