Doc Summary
Monitor Fax Delivery Status Using the Documo API #
Overview #
The View Fax Info endpoint allows you to retrieve detailed information about a fax transmission, including whether the fax has been successfully delivered, is still processing, or has failed.
This endpoint is ideal for applications that need to:
- ✅ Verify whether a fax was delivered successfully
- 📊 Display fax delivery status to users
- 🔍 Troubleshoot failed fax transmissions
- 📄 Retrieve transmission details such as page count and duration
Prerequisite
Before using this endpoint, you must have:
- An active Documo API Key
- The Message ID (
messageId) returned when the fax was originally submitted
📌 Endpoint #
GET https://api.documo.com/v1/fax/{messageId}/info
🔐 Authentication #
Include your API Key in the Authorization header.
| Header | Value |
|---|---|
| Authorization | Basic YOUR_API_KEY |
Replace
YOUR_API_KEYwith your actual API key.
📥 Path Parameter #
| Parameter | Type | Required | Description |
|---|---|---|---|
messageId | UUID | ✅ Yes | The unique identifier of the fax returned by the Send Fax API. |
🚀 Example Request #
curl --location \
'https://api.documo.com/v1/fax/d1077489-5ea1-4db1-9760-853f175e8288/info' \
--header 'Authorization: Basic YOUR_API_KEY'
✅ Successful Response #
{
"messageId": "027012f1-80c9-4be5-b093-1f54783dfa3b",
"status": "success",
"resultCode": "0",
"resultInfo": "OK",
"pagesComplete": 3,
"pagesCount": 3,
"resolvedDate": "2018-01-01T12:00:00.000Z",
"faxNumber": "+18885550000",
"duration": 86318
}
📖 Understanding the Response #
The API returns a large amount of information. The fields below are the most useful for checking fax delivery.
| Field | Description |
|---|---|
| status | Current delivery status of the fax. |
| resultCode | Numeric response code returned by the fax network. |
| resultInfo | Human-readable description of the transmission result. |
| pagesComplete | Number of pages successfully transmitted. |
| pagesCount | Total pages included in the fax. |
| resolvedDate | Timestamp when the fax completed processing. |
| faxNumber | Destination fax number. |
| duration | Total transmission time (milliseconds). |
📊 Fax Status Values #
Use the status field to determine the current state of the fax.
| Status | Meaning |
|---|---|
| 🟢 success | Fax was delivered successfully. |
| 🟡 pending | Fax is still processing or transmitting. |
| 🔴 failed | Fax transmission failed. Review resultCode and resultInfo. |
📝 Best Practices #
✅ Save the messageId returned when submitting the fax.
✅ Poll this endpoint until the status changes from pending to a final state.
✅ Display the resultInfo field to provide meaningful feedback to users.
✅ Store the final status in your application for reporting and audit purposes.
⚠️ Troubleshooting #
| Issue | Recommendation |
|---|---|
| 404 Not Found | Verify that the messageId is valid and belongs to your account. |
| 401 Unauthorized | Confirm your API Key is correct and included in the Authorization header. |
| status = pending | Wait a few seconds and query the endpoint again. |
| status = failed | Review resultCode and resultInfo to determine why the transmission failed. |
Need Help?
If you experience issues accessing the API or interpreting fax statuses, please contact your system administrator or the Dataphone Technical Support team.
