Faxes Service

The Fax Service is used to send faxes to any phone number, using a Phone Terminal Extension currently available in the system. The fax sent using this service does not need any approval. To use this service for an extension, you must first enable fax for it. For more details on sending and receiving faxes, check out the User's Fax Center section of the VoipNow User guide.

This service is available to Apps registered to the following account types:

• Administrator

• Organization

• User

Base URL

https://{domain}/uapi

Endpoints

Method	Endpoint	Description
POST	/faxes/​{userId}/​{extension}	Create Faxes

Create Faxes

This method allows users to send faxes in particular contexts such as User, Organization or Admin (global). Using this request, an App can send a fax. The request is made by an App that is registered to a User account.

The API returns pre-signed upload URLs for each file. Clients must upload the actual file content to these URLs using HTTP PUT requests with the provided headers. The upload URLs are temporary and expire after a short period (typically 10 minutes).

POST /faxes/​{userId}/​{extension}

Request

Path Parameters

Parameter	Type	Required	Description	Default
userId	string	Yes	Id of the User on behalf of whom the Fax is sent. It can take one of the following values: User id Organization id Admin id If missing, userId will be taken from the authorization token.	-
extension	string	Yes	Number of the Extension sending the Fax	-

Authentication

This endpoint requires authentication via cookie or header token.

Payload

Type: Fax

Responses

200 OK

If successful, this method returns a 200 OK HTTP status code with the Id and UID of the newly created Fax resource, along with pre-signed upload URLs for each file. Clients must upload the actual file content to the provided redirectUri using HTTP PUT requests with the specified redirectHeaders.

Example Response

{
  "id": 262,
  "uid": "ba123e75751d52b84f6527062fd20bd1",
  "files": [
    {
      "redirect": true,
      "heUri": "https://api.hubgets.com/at/file/action?id=31mMULR90JvqyO&ver=31n3mJOAMcMtWM&nm=document.pdf&cl=OTHER&vw=main",
      "redirectUri": "https://storage.example.com/bucket/file?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Signature=...",
      "redirectHeaders": {
        "x-amz-meta-he-int-faxout": 1,
        "x-amz-meta-app-faxid": 262
      },
      "contentType": "application/pdf",
      "contentLength": 1048576
    }
  ]
}

204 No Content

If there are no faxes to be sent this method returns 204 No Content HTTP status code. It does not return anything in the response body.

400 Bad Request

If an error occurred, this API can return the standard Errors Codes or one the following:

Error codes:

• fx_recipients_invalid

• fx_approved_invalid

• fx_file_invalid

• fx_max_files_reached

• extension_invalid

• fx_upload_identifier_invalid

• FaxErrors

• extension_invalid

Code Examples

cURL

curl 'https://api.hubgets.com/uapi/faxes/@me/0003*210/' \ 
 -H 'x-xsrf-token: 44HzZ6YIHDN6mbRY' \ 
 -H 'content-type: application/json' \ 
 -H 'cookie: dev=ffffffffffffffff2kjZMApYaH; xsrf-token=44HzZ6YIHDN6mbRY; vn=XI%2Cm-tpsEWgqBMBCNVpeAnUEaeqCpG7f' \ 
 --data-binary '{"recipients":["7778888","1234567890"],"files":[{"uploadIdentifier":"doc001","name":"document.pdf","size":1048576,"contentType":"application/pdf"}]}'