Get fax status
curl --request POST \
--url https://api.amplify.xyz/v1/faxes/status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"job_id": "01M1NSAPE73ZJTEGEZQMHC8P6P"
}
'import requests
url = "https://api.amplify.xyz/v1/faxes/status"
payload = { "job_id": "01M1NSAPE73ZJTEGEZQMHC8P6P" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({job_id: '01M1NSAPE73ZJTEGEZQMHC8P6P'})
};
fetch('https://api.amplify.xyz/v1/faxes/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.amplify.xyz/v1/faxes/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'job_id' => '01M1NSAPE73ZJTEGEZQMHC8P6P'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.amplify.xyz/v1/faxes/status"
payload := strings.NewReader("{\n \"job_id\": \"01M1NSAPE73ZJTEGEZQMHC8P6P\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.amplify.xyz/v1/faxes/status")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"job_id\": \"01M1NSAPE73ZJTEGEZQMHC8P6P\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.amplify.xyz/v1/faxes/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"job_id\": \"01M1NSAPE73ZJTEGEZQMHC8P6P\"\n}"
response = http.request(request)
puts response.read_body{
"status": 1,
"message": "Fax status response.",
"data": {
"job_id": "01M1NSAPE73ZJTEGEZQMHC8P6P",
"from_number": "+19073131400",
"to_number": "+14084132233",
"fax_call_length": 0,
"fax_call_start": 1788511347,
"fax_call_end": null,
"fax_total_pages": 1,
"fax_transferred_pages": 1,
"fax_status": "Sending",
"message": "",
"code": 0
}
}{
"status": 0,
"message": "No record found"
}Send faxes
Get fax status
Retrieve the current transmission status and delivery details for a fax job.
POST
/
v1
/
faxes
/
status
Get fax status
curl --request POST \
--url https://api.amplify.xyz/v1/faxes/status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"job_id": "01M1NSAPE73ZJTEGEZQMHC8P6P"
}
'import requests
url = "https://api.amplify.xyz/v1/faxes/status"
payload = { "job_id": "01M1NSAPE73ZJTEGEZQMHC8P6P" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({job_id: '01M1NSAPE73ZJTEGEZQMHC8P6P'})
};
fetch('https://api.amplify.xyz/v1/faxes/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.amplify.xyz/v1/faxes/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'job_id' => '01M1NSAPE73ZJTEGEZQMHC8P6P'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.amplify.xyz/v1/faxes/status"
payload := strings.NewReader("{\n \"job_id\": \"01M1NSAPE73ZJTEGEZQMHC8P6P\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.amplify.xyz/v1/faxes/status")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"job_id\": \"01M1NSAPE73ZJTEGEZQMHC8P6P\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.amplify.xyz/v1/faxes/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"job_id\": \"01M1NSAPE73ZJTEGEZQMHC8P6P\"\n}"
response = http.request(request)
puts response.read_body{
"status": 1,
"message": "Fax status response.",
"data": {
"job_id": "01M1NSAPE73ZJTEGEZQMHC8P6P",
"from_number": "+19073131400",
"to_number": "+14084132233",
"fax_call_length": 0,
"fax_call_start": 1788511347,
"fax_call_end": null,
"fax_total_pages": 1,
"fax_transferred_pages": 1,
"fax_status": "Sending",
"message": "",
"code": 0
}
}{
"status": 0,
"message": "No record found"
}Use the
job_id returned by Send a fax or Forward a fax to retrieve the latest state of that fax. job_id is required.
The response includes the current status, sending and destination numbers, page counts, call timing, and any status message or code reported by the fax service.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Unique identifier returned when the fax was submitted.
Example:
"01M1NSAPE73ZJTEGEZQMHC8P6P"
