iFax API v1

https://www.ifaxapp.com/docs/api/v1
Admin
iFax API is a comprehensive faxing solution that enables developers to send, receive, and manage...
Tokens:28,590
Snippets:117
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### Receive Fax Callback Handling (Example)

Source: https://www.ifaxapp.com/docs/api/v1

Illustrates how to handle an incoming fax callback from iFax. The callback is a multipart POST request containing the fax PDF in a 'filename' form part. This example outlines the general structure of processing such a request.

```text
When a fax is received, iFax will post information about the fax to your receive fax callback URL, if one is available. You can set up a receive callback URL on the callbacks page in the web console.
The callback HTTP request is a multipart POST and should be processed like a form submission. The PDF of the received fax will be contained in a file upload part of the request named ‘filename’.

Retries:
If a callback fails, we will automatically retry the callback up to 16 times. There will be a backoff before each retry, which increases as follows:
Retry No. | Backoff
---
1 | 5 minutes
2 | 10 minutes
3 | 20 minutes
4 | 30 minutes
5 | 60 minutes
```

--------------------------------

### Send Fax Form-data Request Example (PHP cURL)

Source: https://www.ifaxapp.com/docs/api/v1

This example shows how to send a fax using the iFax API with a form-data request, commonly used with PHP's cURL library. It illustrates how to pass various fax parameters and file attachments, including local files using `CURLFILE` and base64 encoded data. The structure for nested `faxData` elements is also demonstrated.

```php
array(
    'faxNumber' => '+12345678901',
    'callerId' => '+12345678901',
    'templateId'=> '00000',
    'smartDocumentId'=>'0000',
    'subject' : 'test subject',
    'from_name' : 'abc',
    'to_name' : 'xyz',
    'message' : 'sample fax',
    'send_at' : '2019-11-14T00:55:31.820Z',
    'faxQuality' :'Standard',
    'faxData[0][fileName]' => 'abc.pdf',
    'faxData[0][fileUrl]'=> new CURLFILE('/C:/Users/fw4.pdf'),
    'faxData[0][pages]' => ["1-5","2", "1-10"],
    'faxData[1][fileName]' => '123.pdf',
    'faxData[1][fileData]'=> 'Base64 encoded string',
    'faxData[1][pages]' => ["1","2"]
)
```

--------------------------------

### Send Fax Request using cURL

Source: https://www.ifaxapp.com/docs/api/v1

Demonstrates how to send a fax using the cURL command-line tool. It specifies the HTTP method (POST) and includes the access token for authentication. This is a direct API call example.

```shell
curl -X POST https://api.ifaxapp.com/v1/customer/fax-send \
-H 'accessToken:API_KEY'
```

--------------------------------

### Get Labels List

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves a list of all available labels for a customer. Requires an 'accessToken' for authentication. The API response is in JSON format.

```JSON
{
  "status": 1,
  "data": [
    {
      "id": 1111,
      "name": "test1",
      "subLabel": [
        {
          "id": 2222,
          "name": "test2"
        }
      ]
    }
  ]
}
```

--------------------------------

### Send Fax API Response Example

Source: https://www.ifaxapp.com/docs/api/v1

This is a sample JSON response received after successfully submitting a fax request to the iFax API. It includes a status code (1 for success), a message indicating the fax is being processed, and a data object containing the unique `jobId` assigned to the fax.

```json
{
  "status": 1,
  "message": "Fax processed for sending",
  "data": {
            "jobId": 12345
          }
}
```

--------------------------------

### Get Country List (Ruby)

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves a list of countries supported by the iFaxApp API. Requires 'Content-Type', 'Accept', and 'accessToken' headers. Returns a JSON object with status and a data array of country objects.

```ruby
{
  
}
```

--------------------------------

### Example Fax Object Structure

Source: https://www.ifaxapp.com/docs/api/v1

This JSON object represents a fax job sent through the iFax API. It includes details such as job ID, sender and receiver numbers, call duration, timestamps, page counts, status, and any associated messages or error codes.

```json
{
  "jobId": 12345,
  "fromNumber": "+441224515014",
  "toNumber": "+15065001844",
  "faxCallLength": 173,
  "faxCallStart": 1610966603,
  "faxCallEnd": 1610966723,
  "faxTotalPages": 20,
  "faxTransferredPages": 20,
  "faxStatus": "delivered",
  "message": "NORMAL_CLEARING",
  "code": 0,
  "direction": "sent"
}
```

--------------------------------

### Send Fax JSON Request Example

Source: https://www.ifaxapp.com/docs/api/v1

This snippet demonstrates how to construct a JSON request body for sending a fax using the iFax API. It includes parameters for recipient fax number, caller ID, subject, message, and attachment details like file name, URL, or base64 encoded data. The fax quality and optional scheduling can also be specified.

```json
{
  "faxNumber" : "+12345678901",
  "callerId" : "+12345678901",
  "templateId": "0000",
  "smartDocumentId":"0000",
  "subject" : "test subject",
  "from_name" : "abc",
  "to_name" : "xyz",
  "message" : "sample fax",
  "send_at" : "2019-11-14T00:55:31.820Z",
  "faxQuality" :"Standard",
  "faxData" : [
    {
      "fileName" : "abc.pdf",
      "fileUrl" : "HTTP url of file",
      "pages": ["1-5","2", "1-10"]
    },
    {
      "fileName" : "xyz.pdf",
      "fileData" : "Base64 encoded string",
      "pages": ["1","2"]
    }
  ]
}
```

--------------------------------

### Get Area List by Country Abbreviation (Ruby)

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves a list of areas (states/provinces) for a given country abbreviation. Requires 'Content-Type', 'Accept', and 'accessToken' headers, and a JSON body containing the 'abbreviation'. Returns a JSON object with status and a data array of area objects.

```ruby
{
	"abbreviation" : "US"
}
```

--------------------------------

### Get Fax Status using Ruby

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves the status of a fax job using the Fax API. Requires a valid accessToken and the jobId of the fax. The API returns the fax status, call details, and delivery information.

```Ruby
require 'httparty'

url = 'https://api.ifaxapp.com/v1/customer/fax-status'
headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'accessToken' => 'YOUR_ACCESS_TOKEN'
}
body = {
  'jobId' => 12345
}

response = HTTParty.post(url, headers: headers, body: body.to_json)
puts response.body
```

--------------------------------

### Simulate HTTP Method with POST and _method parameter

Source: https://www.ifaxapp.com/docs/api/v1

Shows how to simulate different HTTP methods (like POST) when the HTTP client does not support them directly. The desired method is passed as a form parameter `_method`. This is useful for compatibility with certain clients.

```shell
curl https://api.ifaxapp.com/v1/customer/fax-send \
-F '_method=POST' \
-H 'accessToken:API_KEY'
```

--------------------------------

### Method Simulation

Source: https://www.ifaxapp.com/docs/api/v1

Explains how to simulate different HTTP methods (like POST) using the `_method` parameter if the HTTP client does not support them.

```APIDOC
## Method Simulation

### Description
If your HTTP client does not support all HTTP methods, you can simulate them by passing the desired method in the `_method` parameter.

### Method
POST

### Endpoint
`https://api.ifaxapp.com/v1/customer/fax-send`

### Parameters
#### Query Parameters
- **_method** (string) - Required - The HTTP method to simulate (e.g., 'POST', 'GET').
- **accessToken** (string) - Required - Your API key for authentication.

### Request Example
```bash
curl https://api.ifaxapp.com/v1/customer/fax-send \
-F '_method=POST' \
-H 'accessToken:API_KEY'
```

### Response
(Response structure depends on the simulated method and endpoint.)
```

--------------------------------

### POST /v1/customer/contact/create

Source: https://www.ifaxapp.com/docs/api/v1

Adds a new contact to the system. Requires detailed contact information.

```APIDOC
## POST /v1/customer/contact/create

### Description
Adds a new contact to the system. Requires detailed contact information.

### Method
POST

### Endpoint
https://api.ifaxapp.com/v1/customer/contact/create

### Headers
- **Content-Type** (application/json) - Required
- **Accept** (application/json) - Required
- **accessToken** (API key) - Required

### Parameters
#### Request Body
- **firstName** (String) - First name of the contact.
- **lastName** (String) - Last name of the contact.
- **email** (String) - Email address of the contact.
- **companyName** (String) - Name of the company.
- **jobTitle** (String) - Job title of the contact.
- **directMessageEmail** (String) - Direct messaging email for secure communication.
- **phoneNumber** (String) - Primary phone number of the contact.
- **workNumber** (String) - Work phone number.
- **faxNumber** (String) - Fax number of the contact.
- **type** (String) - Type of contact. Possible values are "Organization" and "Individual".
- **contactCustomFields** (Array) - List of custom fields as key-value pairs. Each object contains:
  - **fieldTitle** (String) - You will receive fieldTitle from the Contact Custom Field List API response.
  - **fieldValue** (String)

### Request Example
```json
{
  "firstName": "",
  "lastName": "",
  "email": "john.doe@example1.com",
  "companyName": "Enterpisess",
  "jobTitle": "Manager",
  "directMessageEmail": "john.doe@direct1.example.com",
  "phoneNumber": "12052771190",
  "workNumber": "12052771190",
  "faxNumber": "12052771190",
  "type": "Organization",
  "contactCustomFields": [
    {
      "fieldTitle": "Numbers",
      "fieldValue": "1234"
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (Integer) - Indicates the success of the operation (1 for success).
- **message** (String) - A message describing the result of the operation.

#### Response Example
```json
{
  "status": 1,
  "message": "Contact has been saved successfully."
}
```
```

--------------------------------

### Get Transmission Receipt (JSON)

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves the transmission receipt for a fax. This is essential for confirming fax delivery or status. Requires 'transactionId' and 'direction'.

```json
{
    "transactionId": 1234657,
    "direction": "OB"
}
```

--------------------------------

### Billing Process Overview

Source: https://www.ifaxapp.com/docs/api/v1

Explains how billing works for fax API calls, including balance checks, deductions, and refunds for failed transmissions.

```APIDOC
# Billing Process

This section outlines the billing process for fax API calls.

## Sending Faxes

1.  **Initial Balance Check**: When an API call is made to send a fax, the system checks if your balance is sufficient for the fax price. If not, the call results in an error.
2.  **Queueing for Sending**: If the balance is sufficient, the fax is queued for sending.
3.  **Pre-Transmission Balance Check**: Immediately before the fax is sent, the balance is checked again. If insufficient, the call results in an error. If sufficient, the price of the fax is deducted from your account, considering all recipients.
4.  **Post-Transmission Credit**: After the fax transmission ends, the system checks for any recipients who did not receive the fax successfully. The price of the fax is credited back to your account for each such recipient.
```

--------------------------------

### Get Contact List (JSON)

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves a list of contacts. Supports optional 'sortBy' (Newest/Oldest) and 'lastContactId' for pagination. The API expects JSON formatted request and response.

```json
{
	"lastContactId":"eyJjdCI6Im9IMytVU2JhVFVKVVlyMzN1RzNiNFE9PSIsIml2IjoiOTU1M2MzYjQwNDFmOWUwMGI5NzViM2ExM2ViMTJjMzYiLCJzIjoiNjdjMmVkYzhjNzk4MmZjMSJ9sdsdsdsdsdsdsdsdsdsd",
	"sortBy":"Oldest"
}
```

--------------------------------

### Get Custom Fields for Fax

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves custom fields associated with a fax. Requires 'jobId' and 'faxType' as parameters. Authentication is handled by the 'accessToken'. The response contains a list of custom fields with their IDs and values.

```JSON
{
  "jobId": "123465",
  "faxType": "OB"
}
```

--------------------------------

### POST /v1/customer/inbound/buy

Source: https://www.ifaxapp.com/docs/api/v1

Purchases a fax number.

```APIDOC
## POST /v1/customer/inbound/buy

### Description
Purchases a fax number.

### Method
POST

### Endpoint
https://api.ifaxapp.com/v1/customer/inbound/buy

### Headers
- **Content-Type** (string) - Required - application/json
- **Accept** (string) - Required - application/json
- **accessToken** (string) - Required - API key

### Request Body
- **faxNumber** (string) - Required - The fax number to purchase.

### Request Example
```json
{
    "faxNumber" : "+12052555022"
}
```

### Response
#### Success Response (200)
- **status** (integer) - Indicates the success of the operation.
- **message** (string) - A message describing the result of the purchase.
- **data** (object) - Contains details of the purchased number.
  - **numberId** (string) - The ID of the purchased number.
  - **orderId** (string) - The ID of the order.

#### Response Example
```json
{
    "status": 1,
    "message": "Number purchased successfully",
    "data": {
        "numberId": "234565",
        "orderId": "12876457876537896"
    }
}
```
```

--------------------------------

### HTTP Authentication

Source: https://www.ifaxapp.com/docs/api/v1

Details on how to authenticate API calls using an API key via the `accessToken` header.

```APIDOC
## HTTP Authentication

### Description
Most API calls require authentication. You can authenticate by including your API key in the `accessToken` header.

### Method
GET (or other applicable methods)

### Endpoint
`https://api.ifaxapp.com/v1/customer/fax-send`

### Parameters
#### Headers
- **accessToken** (string) - Required - Your API key for authentication.

### Request Example
```bash
curl 'https://api.ifaxapp.com/v1/customer/fax-send' \
-H 'accessToken:API_KEY'
```

### Response
(Response structure depends on the endpoint.)
```

--------------------------------

### Send a Fax

Source: https://www.ifaxapp.com/docs/api/v1

This section details how to send a fax using the iFax API. It covers the necessary HTTP method, endpoint, and parameters.

```APIDOC
## POST /customer/fax-send

### Description
Sends a fax to a specified recipient.

### Method
POST

### Endpoint
`https://api.ifaxapp.com/v1/customer/fax-send`

### Parameters
#### Query Parameters
- **accessToken** (string) - Required - Your API key for authentication.

### Request Example
```bash
curl -X POST https://api.ifaxapp.com/v1/customer/fax-send \
-H 'accessToken:API_KEY'
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the fax sending operation.
- **message** (string) - A message describing the result of the operation.

#### Response Example
```json
{
  "status": "success",
  "message": "Fax sent successfully."
}
```
```

--------------------------------

### Get Received Faxes List (Ruby)

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves a list of received faxes. Requires `numberId` and `orderId`. Optional parameters include `markedAs`, `startDate`, and `endDate`. The API returns a JSON object with status, message, and a data array containing fax details.

```ruby
{
  "numberId" : "1",
  "orderId" : "1",
  "markedAs":"Done",
  "startDate":"05/03/2024",
  "endDate":"10/03/2024"
}
```

--------------------------------

### User and Account Management

Source: https://www.ifaxapp.com/docs/api/v1

Endpoints for managing user credentials and account information.

```APIDOC
## POST /api/v1/auth/login

### Description
Authenticates a user and returns an access token.

### Method
POST

### Endpoint
/api/v1/auth/login

### Parameters
#### Request Body
- **username** (string) - Required - The user's username.
- **password** (string) - Required - The user's password.

### Response
#### Success Response (200)
- **access_token** (string) - The authentication token for subsequent requests.
- **token_type** (string) - The type of token (e.g., 'Bearer').

#### Response Example
```json
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer"
}
```

## GET /api/v1/user/credit

### Description
Retrieves the current credit balance for the authenticated user.

### Method
GET

### Endpoint
/api/v1/user/credit

### Response
#### Success Response (200)
- **credit** (number) - The user's available credit balance.

#### Response Example
```json
{
  "credit": 100.50
}
```

## PUT /api/v1/user/sip/credentials

### Description
Updates the SIP credentials for the user.

### Method
PUT

### Endpoint
/api/v1/user/sip/credentials

### Parameters
#### Request Body
- **old_connection_id** (string) - Required - The current connection ID.
- **old_sip_username** (string) - Required - The current SIP username.
- **new_connection_id** (string) - Required - The new connection ID.
- **new_sip_username** (string) - Required - The new SIP username.
- **new_sip_password** (string) - Required - The new SIP password.

### Response
#### Success Response (200)
- **message** (string) - Success message indicating the credentials were updated.

#### Response Example
```json
{
  "message": "SIP credentials updated successfully."
}
```
```

--------------------------------

### POST /v1/customer/inbound/search

Source: https://www.ifaxapp.com/docs/api/v1

Searches for available fax numbers for purchase.

```APIDOC
## POST /v1/customer/inbound/search

### Description
Searches for available fax numbers for purchase.

### Method
POST

### Endpoint
https://api.ifaxapp.com/v1/customer/inbound/search

### Headers
- **Content-Type** (string) - Required - application/json
- **Accept** (string) - Required - application/json
- **accessToken** (string) - Required - API key

### Request Body
- **faxNumber** (string) - Required - The fax number to search for.

### Request Example
```json
{
    "faxNumber" : "+12052555022"
}
```

### Response
#### Success Response (200)
- **status** (integer) - Indicates the success of the operation.
- **message** (string) - A message describing the result of the search.

#### Response Example
```json
{
    "status": 1,
    "message": "Number available for purchase"
}
```
```

--------------------------------

### Download Fax (POST)

Source: https://www.ifaxapp.com/docs/api/v1

Initiates the download of a specific fax using its unique job ID. The fax data is returned in Base64 encoded format. Requires authentication.

```JSON
{
  "jobId": "123456"
}
```

--------------------------------

### Get Inbound Numbers by Area ID (Ruby)

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves a list of inbound phone numbers for a specific area ID. Requires 'Content-Type', 'Accept', and 'accessToken' headers, and a JSON body containing the 'id'. Returns a JSON object with status and a data array of phone number strings.

```ruby
{
	"id" : "1"
}
```

--------------------------------

### POST /v1/customer/requestAI

Source: https://www.ifaxapp.com/docs/api/v1

Submits a fax for AI processing (OCR or NLP). Requires jobId, direction, and type as parameters.

```APIDOC
## POST /v1/customer/requestAI

### Description
Submits a fax for AI processing, such as Optical Character Recognition (OCR) or Natural Language Processing (NLP). This endpoint requires a `jobId` obtained from the fax-list API, the `direction` of the fax (inbound or outbound), and the `type` of processing (OCR or NLP).

### Method
POST

### Endpoint
https://api.ifaxapp.com/v1/customer/requestAI

### Headers
- **Content-Type** (application/json) - Required
- **Accept** (application/json) - Required
- **accessToken** (API key) - Required

### Request Body
- **jobId** (String) - Required - The ID of the fax job.
- **direction** (String) - Required - The direction of the fax ('inbound' or 'outbound').
- **type** (String) - Required - The type of AI processing ('OCR' or 'NLP').

### Request Example
```json
{
  "jobId": "1",
  "direction": "inbound",
  "type": "OCR"
}
```

### Response
#### Success Response (200)
- **status** (Integer) - Indicates the success of the operation (1 for success).
- **message** (String) - A message describing the result of the operation.

#### Response Example
```json
{
  "status": 1,
  "message": "Fax OCR request submitted successfully."
}
```
```

--------------------------------

### HTTP Authentication with Access Token using cURL

Source: https://www.ifaxapp.com/docs/api/v1

Illustrates how to authenticate an API request using an access token provided in the 'accessToken' HTTP header. This method is used for direct HTTP-level authentication with the iFax API.

```shell
curl 'https://api.ifaxapp.com/v1/customer/fax-send' \
-H 'accessToken:API_KEY'
```

--------------------------------

### POST /v1/customer/outbound/report

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves client reports based on date range and direction.

```APIDOC
## POST /v1/customer/outbound/report

### Description
Retrieves client reports based on date range and direction.

### Method
POST

### Endpoint
https://api.ifaxapp.com/v1/customer/outbound/report

### Headers
- **Content-Type** (string) - Required - application/json
- **Accept** (string) - Required - application/json
- **accessToken** (string) - Required - API key

### Request Body
- **startDate** (string) - Required - The start date for the report (YYYY-MM-DD).
- **endDate** (string) - Required - The end date for the report (YYYY-MM-DD).
- **direction** (string) - Optional - The direction of faxes ('OB' for outbound, 'IB' for inbound). If omitted, all records are returned.

### Request Example
```json
{
    "startDate" : "2024-02-07",
    "endDate" : "2024-03-05",
    "direction" : "IB"
}
```

### Response
#### Success Response (200)
- **status** (integer) - Indicates the success of the operation.
- **data** (array) - An array of client report objects.
  - **clientId** (integer) - The client's unique identifier.
  - **firstName** (string) - The client's first name.
  - **lastName** (string) - The client's last name.
  - **email** (string) - The client's email address.
  - **pagesSent** (integer) - The number of pages sent.
  - **faxesSent** (integer) - The number of faxes sent.
  - **pagesReceived** (integer) - The number of pages received.
  - **faxesReceived** (integer) - The number of faxes received.
  - **cost** (float) - The total cost.
  - **faxNumbers** (array) - A list of fax numbers associated with the client.
    - **numberId** (integer) - The ID of the fax number.
    - **faxNumber** (string) - The fax number.
    - **faxNumberLabel** (string) - The label for the fax number.

#### Response Example
```json
{
    "status": 1,
    "data": [
        {
             "clientId" : 6698,
             "firstName" : "test",
             "lastName" : "client",
             "email" : "test@gmail.com",
             "pagesSent" : 0,
             "faxesSent" : 0,
             "pagesReceived" : 207,
             "faxesReceived" : 13,
             "cost" : 6.21,
             "faxNumbers" : [
                     {
                          "numberId" : 12346,
                          "faxNumber" : "+1 (111) 111-1111",
                          "faxNumberLabel" : "" 
                     }
             ]
        }
    ]
}
```
```

--------------------------------

### POST /v1/customer/inbound/number-list

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves a list of purchased fax numbers associated with the customer account.

```APIDOC
## POST /v1/customer/inbound/number-list

### Description
Retrieves a list of all purchased fax numbers for the customer account.

### Method
POST

### Endpoint
https://api.ifaxapp.com/v1/customer/inbound/number-list

### Headers
- **Content-Type** (string) - Required - application/json
- **Accept** (string) - Required - application/json
- **accessToken** (string) - Required - API key from dashboard settings

### Request Body
This endpoint does not require a request body.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **status** (integer) - Indicates success (1) or failure (0).
- **message** (string) - A message describing the result of the operation.
- **data** (array) - An array of fax number objects.
  - **numberId** (string) - Unique identifier for the fax number.
  - **orderId** (string) - The order ID associated with the purchased number.
  - **faxNumber** (string) - The actual fax number.

#### Response Example
```json
{
    "status": 1,
    "message": "Numbers list retrieved successfully",
    "data": [
        {
            "numberId": "200989",
            "orderId": "1595589515890656281",
            "faxNumber": "1222567890"
        }
    ]
}
```
```

--------------------------------

### Add Contact (API)

Source: https://www.ifaxapp.com/docs/api/v1

This snippet shows how to add a new contact to the iFaxApp platform via the API. A POST request to '/v1/customer/contact/create' is used, with a JSON body containing various contact details such as name, email, company, and custom fields. Essential headers like 'Content-Type', 'Accept', and 'accessToken' must be included.

```json
{
  "firstName": "",
  "lastName": "",
  "email": "john.doe@example1.com",
  "companyName": "Enterpisess",
  "jobTitle": "Manager",
  "directMessageEmail": "john.doe@direct1.example.com",
  "phoneNumber": "12052771190",
  "workNumber": "12052771190",
  "faxNumber": "12052771190",
  "type": "Organization",
  "contactCustomFields": [
    {
      "fieldTitle": "Numbers",
      "fieldValue": "1234"
    }
  ]
}
```

--------------------------------

### Fax Download API

Source: https://www.ifaxapp.com/docs/api/v1

Downloads a specific fax file using its job ID.

```APIDOC
## POST /v1/customer/fax-download

### Description
Downloads a specific fax file using its job ID.

### Method
POST

### Endpoint
https://api.ifaxapp.com/v1/customer/fax-download

### Headers
- **Content-Type**: application/json - Required
- **Accept**: application/json - Required
- **accessToken**: API key - Required

### Request Body
- **jobId** (Integer) - Required - Unique ID generated when sending a fax.

### Request Example
```json
{
    "jobId": "123456"
}
```

### Response
#### Success Response (200)
- **status** (Integer) - Indicates the success of the operation.
- **message** (String) - A message describing the result.
- **data** (Array) - An array containing file information.
  - **name** (String) - The name of the file.
  - **file** (String) - Base64 encoded data of the file.

#### Response Example
```json
{
    "status": 1,
    "message": "The fax download successfully",
    "data": [
        {
            "name": "file1",
            "file": "Base64 encode data of the file"
        }
    ]
}
```
```

--------------------------------

### POST /v1/customer/inbound/fax-list

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves a list of received faxes with optional filtering by date range and status.

```APIDOC
## POST /v1/customer/inbound/fax-list

### Description
Retrieves a list of received faxes. This endpoint allows filtering by date range and marking status.

### Method
POST

### Endpoint
https://api.ifaxapp.com/v1/customer/inbound/fax-list

### Headers
- **Content-Type** (string) - Required - application/json
- **Accept** (string) - Required - application/json
- **accessToken** (string) - Required - API key from dashboard settings

### Request Body
- **numberId** (string) - Required - Obtained from buy number API or number-list API.
- **orderId** (string) - Required - Obtained from buy number API or number-list API.
- **markedAs** (string) - Optional - Possible values: "Done", "Not Done".
- **startDate** (string) - Optional - Date format: MM/DD/YYYY.
- **endDate** (string) - Optional - Date format: MM/DD/YYYY.

### Request Example
```json
{
    "numberId" : "1",
    "orderId" : "1",
    "markedAs":"Done",
    "startDate":"05/03/2024",
    "endDate":"10/03/2024"
}
```

### Response
#### Success Response (200)
- **status** (integer) - Indicates success (1) or failure (0).
- **message** (string) - A message describing the result of the operation.
- **data** (array) - An array of fax objects.
  - **jobId** (string) - Unique identifier for the fax job.
  - **transactionId** (string) - Unique identifier for the transaction.
  - **receiver** (string) - The receiving fax number.
  - **duration** (string) - The duration of the fax in seconds.
  - **pages** (string) - The number of pages in the fax.
  - **receivedTime** (string) - The timestamp when the fax was received.
  - **sender** (string) - The sending fax number.

#### Response Example
```json
{
    "status": 1,
    "message": "Faxes list retrieved successfully",
    "data": [
        {
            "jobId": "764118",
            "transactionId": "1175612",
            "receiver": "15812220900",
            "duration": "21",
            "pages": "1",
            "receivedTime": "2021-11-11 12:00:47",
            "sender": "19073131400"
        }
    ]
}
```
```

--------------------------------

### Receive Fax Callback

Source: https://www.ifaxapp.com/docs/api/v1

Handles callbacks when a fax is received. iFax will post information about the received fax to a configured URL.

```APIDOC
# Receive fax callback

When a fax is received, iFax will post information about the fax to your receive fax callback URL, if one is available. You can set up a receive callback URL on the callbacks page in the web console.

The callback HTTP request is a multipart POST and should be processed like a form submission. The PDF of the received fax will be contained in a file upload part of the request named ‘filename’.

## Retries
If a callback fails, we will automatically retry the callback up to 16 times. There will be a backoff before each retry, which increases as follows:

| Retry No. | Backoff |
|---|---|
| 1 | 5 minutes |
| 2 | 10 minutes |
| 3 | 20 minutes |
| 4 | 30 minutes |
| 5 | 60 minutes |
```

--------------------------------

### POST /v1/customer/inbound/fax-list-all

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves a list of all received faxes. This endpoint does not require any specific request body parameters.

```APIDOC
## POST /v1/customer/inbound/fax-list-all

### Description
Retrieves a comprehensive list of all inbound faxes received by the customer. This endpoint is useful for auditing, tracking, and managing incoming fax communications.

### Method
POST

### Endpoint
https://api.ifaxapp.com/v1/customer/inbound/fax-list-all

### Headers
- **Content-Type** (application/json) - Required
- **Accept** (application/json) - Required
- **accessToken** (API key) - Required

### Request Body
This endpoint does not require a request body.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **status** (Integer) - Indicates the success of the operation (1 for success).
- **message** (String) - A message confirming the retrieval of the fax list.
- **data** (Array) - An array of fax objects, each containing details like `jobId`, `transactionId`, `receiver`, `sender`, `duration`, `pages`, and `receivedTime`.

#### Response Example
```json
{
  "status": 1,
  "message": "Faxes list retrieved successfully",
  "data": [
    {
      "jobId": "2434914",
      "transactionId": "3179627",
      "receiver": "+12108989811",
      "sender": "+12108989811",
      "duration": "20",
      "pages": "1",
      "receivedTime": "1703678418"
    },
    {
      "jobId": "2434922",
      "transactionId": "3179637",
      "receiver": "+12108989811",
      "sender": "+19382530358",
      "duration": "21",
      "pages": "1",
      "receivedTime": "1703678603"
    }
  ]
}
```
```

--------------------------------

### Mark as Done API

Source: https://www.ifaxapp.com/docs/api/v1

Marks a fax as done, categorizing it by type (outbound, inbound, document).

```APIDOC
## POST /v1/customer/mark-as-done

### Description
Marks a fax as done, categorizing it by type (outbound, inbound, document).

### Method
POST

### Endpoint
https://api.ifaxapp.com/v1/customer/mark-as-done

### Headers
- **Content-Type**: application/json - Required
- **Accept**: application/json - Required
- **accessToken**: API key - Required

### Request Body
- **type** (String) - Required - Type of fax: "outbound", "inbound", or "document".
- **jobId** (Integer) - Required - Unique ID generated when sending a fax.

### Request Example
```json
{
    "type": "outbound",
    "jobId": "123456"
}
```

### Response
#### Success Response (200)
- **status** (Integer) - Indicates the success of the operation.
- **message** (String) - A message confirming the action.

#### Response Example
```json
{
    "status": 1,
    "message": "Document mark as done successfully"
}
```
```

--------------------------------

### Request AI Processing for Fax (JSON)

Source: https://www.ifaxapp.com/docs/api/v1

Submits a request to process a fax using AI, either for OCR or NLP. Requires jobId, direction (inbound/outbound), and type (OCR/NLP). The API key must be included in the request headers.

```JSON
{
  "jobId": "1",
  "direction": "inbound",
  "type": "OCR"
}
```

--------------------------------

### Country List API

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves a list of countries supported by the FaxApp API. This endpoint requires authentication.

```APIDOC
## POST /v1/customer/inbound/country-list

### Description
Retrieves a list of countries supported by the FaxApp API.

### Method
POST

### Endpoint
https://api.ifaxapp.com/v1/customer/inbound/country-list

### Headers
- **Content-Type** (application/json) - Required
- **Accept** (application/json) - Required
- **accessToken** (string) - Required - API key for authentication.

### Request Body
This endpoint does not require a request body.

### Request Example
```json
{} 
```

### Response
#### Success Response (200)
- **status** (integer) - Indicates the success of the operation.
- **data** (array) - An array of country objects.
  - **code** (string) - The country code.
  - **abbreviation** (string) - The country abbreviation.
  - **name** (string) - The country name.

#### Response Example
```json
{
    "status": 1,
    "data": [
        {
            "code": "1",
            "abbreviation": "CA",
            "name": "Canada"
        },
        {
            "code": "44",
            "abbreviation": "GB",
            "name": "United Kingdom"
        },
        {
            "code": "1",
            "abbreviation": "US",
            "name": "United States of America"
        }
    ]
}
```
```

--------------------------------

### POST /v1/customer/contact/detail

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves the details of a specific contact using their unique contact ID.

```APIDOC
## POST /v1/customer/contact/detail

### Description
Retrieves the details of a specific contact using their unique contact ID.

### Method
POST

### Endpoint
https://api.ifaxapp.com/v1/customer/contact/detail

### Headers
- **Content-Type** (application/json) - Required
- **Accept** (application/json) - Required
- **accessToken** (API key) - Required

### Parameters
#### Request Body
- **contactId** (String) - Required - You will receive this from the Contact List API response.

### Request Example
```json
{
	"contactId":"03faa662c7b2d8c3ae5643825d2a0b8f"
}
```

### Response
#### Success Response (200)
- **status** (Integer) - Indicates the success of the operation (1 for success).
- **message** (String) - A message describing the result of the operation.
- **data** (Object) - Contains the contact details.
  - **contactId** (String)
  - **firstName** (String)
  - **lastName** (String)
  - **email** (String)
  - **companyName** (String)
  - **jobTitle** (String)
  - **directMessageEmail** (String)
  - **phoneNumber** (String)
  - **workNumber** (String)
  - **faxNumber** (String)
  - **type** (String)
  - **faxNumberFormatted** (String)
  - **createdDateTimeStamp** (Integer)
  - **updatedDateTimeStamp** (Integer)
  - **isOrganization** (Boolean)
  - **fullName** (String)
  - **contactCustomFields** (Array) - List of custom fields.
    - **fieldTitle** (String)
    - **fieldFormat** (String)
    - **fieldType** (String)
    - **fieldValue** (String)

#### Response Example
```json
{
  "status": 1,
  "message": "Contact retrieved successfully.",
  "data": {
    "contactId": "03faa662c7b2d8c3ae5643825d2a0b8f",
    "firstName": "",
    "lastName": "",
    "email": "john.doe@example.com",
    "companyName": "Enterprises",
    "jobTitle": "Manager",
    "directMessageEmail": "john.doe@direct.example.com",
    "phoneNumber": "12052771190",
    "workNumber": "12052771190",
    "faxNumber": "12052771190",
    "type": "Organization",
    "faxNumberFormatted": "1 (205) 727-1190",
    "createdDateTimeStamp": 17545442144,
    "updatedDateTimeStamp": 17545442144,
    "isOrganization": false,
    "fullName": "",
    "contactCustomFields": [
      {
        "fieldTitle": "Numbers",
        "fieldFormat": "Numbers Only",
        "fieldType": "Individual",
        "fieldValue": "1234"
      }
    ]
  }
}
```
```

--------------------------------

### POST /v1/customer/label/label-list

Source: https://www.ifaxapp.com/docs/api/v1

Retrieves a list of all labels associated with a customer account. This endpoint is useful for managing and categorizing faxes.

```APIDOC
## POST /v1/customer/label/label-list

### Description
Retrieves a list of all labels associated with a customer account. This endpoint is useful for managing and categorizing faxes.

### Method
POST

### Endpoint
https://api.ifaxapp.com/v1/customer/label/label-list

### Headers
- **Content-Type** (application/json) - Required
- **Accept** (application/json) - Required
- **accessToken** (API key) - Required

### Request Body
An empty JSON object `{}` is expected for this request.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **status** (integer) - Indicates the success of the operation (1 for success).
- **data** (array) - An array of label objects.
  - **id** (integer) - The unique identifier for the label.
  - **name** (string) - The name of the label.
  - **subLabel** (array) - An array of sub-label objects (optional).
    - **id** (integer) - The unique identifier for the sub-label.
    - **name** (string) - The name of the sub-label.

#### Response Example
```json
{
    "status": 1,
    "data": [
        {
            "id": 1111,
            "name": "test1",
            "subLabel": [
                {
                    "id": 2222,
                    "name": "test2"
                }
            ]
        }
    ]
}
```
```

--------------------------------

### POST /v1/customer/inbound/assign-fax

Source: https://www.ifaxapp.com/docs/api/v1

Assigns a received fax to specific email addresses. Requires jobId and a comma-separated list of emails.

```APIDOC
## POST /v1/customer/inbound/assign-fax

### Description
Assigns an inbound fax to one or more email addresses for notification or distribution. This endpoint requires the `jobId` of the fax and a comma-separated string of `emails` to which the fax should be assigned.

### Method
POST

### Endpoint
https://api.ifaxapp.com/v1/customer/inbound/assign-fax

### Headers
- **Content-Type** (application/json) - Required
- **Accept** (application/json) - Required
- **accessToken** (API key) - Required

### Request Body
- **jobId** (String) - Required - The ID of the fax job to assign.
- **emails** (String) - Required - A comma-separated list of email addresses.

### Request Example
```json
{
  "jobId": "1112121",
  "emails": "test@example.com"
}
```

### Response
#### Success Response (200)
- **status** (Integer) - Indicates the success of the operation (1 for success).
- **message** (String) - A message describing the result of the operation.

#### Response Example
```json
{
  "status": 1,
  "message": "The fax assigned successfully."
}
```
```
Tokens:
Raw