FAX cez API

Používanie virtuálneho faxu cez API. Momentálne je implementované odosielanie faxov, a získavanie statustu všetkých faxov (odoslaných aj prijatých).

Pre prístup k funkciám je potrebné použiť HTTP autentifikáciu (prihlasovanie). Ako prihlasovacie meno sa použije názov virtuálneho faxu (virtual fax konta). Heslo sa konfiguruje v nastaveniach faxového konta (ak heslo nie je v nastaveniach vyplnené, faxovanie cez API sa nedá použiť).

Prístup k API

  • /api/fax/send.json?dst=[DST]&file=[FILE]                     ......  odosielanie faxu
  • /api/fax/retry.json?id=[ID]&addcount=[ADDCOUNT]       ......  opakovať odosielanie ešte neodoslaného faxu
  • /api/fax/status.json?id=[ID]                                         ......  získať stav odosielania faxu

Parametre

  • ID - číselný identifikátor faxovej úlohy (fax job) - bude pridelen po prijatí úlohy na server
  • DST - cieľové telefónne číslo v tvare, v akom sa vytáča na telefóne (t.j. v miestnom, národnom alebo medzinárodnom tvare)
  • FILE - súbor pre odoslanie, vo formáte PDF alebo TIFF (Fax Group 3) - musí sa odoslať cez HTTP POST
  • ADDCOUNT - neodoslanému faxu sa pridajú ďalšie pokusy o odoslanie, minimálne 1 a maximálne 20, default hodnota je 5 ďalších pokusov

Odpoveď - formát JSON


send.json
{"success":true,"message":"Fax queued for sending","errorcode":0,"id":"3274","pages":1}
{"success":false,"message":"Unsupported file format","hint":"Currently supported are TIFF (preferred) and PDF","errorcode":15}

status.json
{"success":true,"message":"See attached fields for fax job details","errorcode":0,"job":{....},"attempts":[{"try":"1",....},{"try":"2",....}]}


Príklad použitia


Pre odoslanie faxu je možné použiť napríklad nástroj cURL:

curl --insecure -u faxaccount:faxpassword https://www.mojoperator.sk/api/fax/send.json -F 'dst=0553335555' -F 'file=@/tmp/test.pdf'


V prípade úspešného prijatia faxovej úlohy na server sa v odpovedi nachádza identifikátor (id) tejto faxovej úlohy:

{"success":true,"message":"Fax queued for sending","errorcode":0,"id":"1234","pages":1}


Stav aktuálnej faxovej úlohy je možné získať pomocou status.json

curl --insecure -u faxaccount:faxpassword https://www.mojoperator.sk/api/fax/status.json?id=1234