Send a fax with Java

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

You can quickly see how the Fax API works by sending yourself a fax using the Fax API.

What you need to know before you start

Before you can get started, you need the following already set up:

• Set all Fax API configuration settings.
• JDK 8 or later and a familiarity with how to create a new Java application.
• Gradle and a familiarity with how use the Gradle build tools.

Set up your Java application

Create a new folder where you want to keep your app project. Then, open a terminal or command prompt to that location.

Create a new Java application using Gradle with the following command:

gradle init

In the prompts, select that you want to create an application, name your project and source package app, and then accept the defaults for the rest of the options.

Modify your application

Open the App.java file in your project folder, located in \app\scr\main\java\app, and populate that file with the "App.java" code found on this page.

package app;

import java.net.*;
import java.net.http.*;
import java.util.*;

public class App {
  private static final String key = "YOUR_access_id";
  private static final String secret = "YOUR_access_secret";
  private static final String projectId = "YOUR_project_id";
  private static final String to = "YOUR_to_number";
  private static final String contentUrl = "YOUR_content_url";
  private static final String callbackUrl = "YOUR_callback_url";

  public static void main(String[] args) throws Exception {
    var httpClient = HttpClient.newBuilder().build();

    var payload = String.join("\n"
      , "{"
      , "  \"to\": \"" + to + "\","
      , "  \"contentUrl\":" + contentUrl + "\","
      , "  \"callbackUrl\":" + callbackUrl + "\""
      , "}"
    );

    var host = "https://fax.api.sinch.com/v3/projects/" + projectId;
    var pathname = "/faxes";
    var request = HttpRequest.newBuilder()
      .POST(HttpRequest.BodyPublishers.ofString(payload))
      .uri(URI.create(host + pathname ))
      .header("Content-Type", "application/json")
      .header("Authorization", "Basic " + Base64.getEncoder().encodeToString((key + ":" + secret).getBytes()))
      .build();

    var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());

    System.out.println(response.body());
  }
}

This code sends a fax to a specified number using the Sinch Fax API.

To

In this example you want to fax a phone number. Change the value of the to parameter to the phone number you verified in your dashboard in E.164 format.

Content URL

The Fax API can send either files directly or the URL of a web page or other online resource. For the purposes of this tutorial, use a web page because it's the easiest way to get started. Change the value of YOUR_content_url to the URL of the web page.

Callback URL

If you provide a callback URL on your Fax service, the Fax API can send notification events to your server about your outgoing fax, such as when or if the fax was delivered. You can set that callback URL in your request body. Change the value of YOUR_callback_url to the URL of your server that's listening to incoming requests.

Fill in your parameters

Before you can run the code, you need to update some more values so you can connect to your Sinch account. Update the following parameters with your own values:

Save the file.

Send your first fax

Now you can execute the code and send your fax. Run the following command:

gradle run

You should receive a fax to the number you specified with the web page that you configured.

Additional resources

• API specification