Izmantojiet HTTPS un HTTP Basic autentifikāciju ar apstiprinātiem API akreditācijas datiem. Glabājiet akreditācijas datus savā lietojumprogrammas serverī. Šie Hosted PBX galapunkti izmanto /hpbx/ uz api.multitel.net; neievietojiet /v3. Pārbaudiet gan HTTP rezultātu, gan darbības statusu JSON atbildē.
Faksa ierakstu lasīšana
curl --request POST --user "USERNAME:PASSWORD" \
"https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"Aizstājiet piemēra norēķinu kodu ar savas PBX kodu. Atgrieztie ieraksti ietver faksa laiku, virzienu, avotu, galamērķi, piegādes statusu, mēģinājumus, kļūdas un lapu skaitu. Piegāde joprojām var būt neapstrādāta, kad sūtīšanas pieprasījums ir pieņemts.
Sūtīšanas parametri
Sūtīšanas galapunkts ir POST /hpbx/fax/send/{billing_code}. Šī darbība faktiski nosūta failu. Pirms iesniegšanas sagatavojiet failu un galamērķi, uz kuru kontam ir atļauts sūtīt. Neatkārtojiet sūtīšanu uz labu laimi, ja tās rezultāts nav skaidrs.
| Lauks | Nozīme |
|---|---|
| number | Galamērķa faksa numurs. |
| cidnum | Apstiprināts nosūtīšanas zvanītāja ID. |
| schedule | Plānotais nosūtīšanas laiks, ja tiek izmantots. |
| faxquality / pagesize / pagerotate | Atbalstītās kvalitātes, papīra izmēra un pagriešanas opcijas. |
| statusemail | Autorizētā adrese piegādes paziņojumiem. |
| deleteaftersend | Norāda, vai pēc nosūtīšanas jādzēš saglabātais augšupielādētais fails. |
| filename | Dokumenta atsauce, ko sagaida šī faksa darbplūsma; nav patvaļīgs lokālā faila ceļš. |
Pabeigšanas izsekošana
Pēc iesniegšanas pārbaudiet faksa ieraksta statusu, mēģinājumus un kļūdu. Apstipriniet piegādi, nevis uzskatiet pieņemšanu par piegādi. Portāla faksa dokumentācija dokumentē pašreizējo augšupielādes un sūtīšanas darbplūsmu; tās ceļi un autentifikācija ir atsevišķi no iepriekš minētā galapunkta.