PBX API : POST /fax/

To send the fax, make an HTTP POST request with basic authorization, resource URI:

http(s)://{PBX}/api/v1/fax/

POST Parameters

Required Parameters

NameDescriptionExample
faxNumbersExtensions which the fax will be sendfaxNumbers[0][number]=222
fileNamename upladed file or filefilaName=example.tiff

Optional parameters

NameDescriptionExample
postpone
 postpone=true
faxCover faxCover=true
faxCoverTo Vasya
faxCoverToPhone faxCoverToPhone=777
faxCoverToCompany faxCoverToCompany=company
faxCoverFrom faxCoverFrom=name
faxCoverFromPhone  
faxCoverFromCompany faxCoverFromCompany=company
faxCoverSubject faxCoverSubject=some string
faxCoverNotes faxCoverNotes=some string
faxCoverFromFax  
faxCoverCheckboxUrgent faxCoverCheckboxUrgent=true
faxCoverCheckboxReview faxCoverCheckboxReview=true
faxCoverCheckboxComment faxCoverCheckboxComment=true
faxCoverCheckboxReply faxCoverCheckboxReply=true
faxCoverCheckboxForward faxCoverCheckboxForward=true
postponeDate postponeDate=28/09/2017 11:29

Example:

POST params
faxNumbers[0][number]=666
fileName=example.tiff

 

Result:

http(s)://{PBX}/api/v1/fax/
{
    "type":"result",
    "result":{
        "status":"success",
        "fileExists":true
    }
}