Skip to main content
POST
/
api
/
v2
/
communication
/
send-fax
Python
from samplehc import SampleHealthcare

client = SampleHealthcare(
    api_key="My API Key",
)
response = client.v2.communication.send_fax(
    document={
        "id": "id",
        "file_name": "fileName",
    },
    to="to",
)
print(response.async_result_id)
{
  "asyncResultId": "<string>"
}

Body

application/json
​
to
string
required

The fax number to send the document to

​
document
object
required

The document to be sent via fax

​
enableBatchCollisionAvoidance
boolean
default:false

Recommended for high-volume fax operations or when sending to recipients who may receive multiple faxes simultaneously. Prevents transmission failures by automatically queuing your fax when another transmission to the same number is already in progress. Your fax will wait and automatically send once the line is clear, ensuring reliable delivery without manual intervention.

​
enableBatchDelay
boolean
default:false

If enabled, the fax will be sent in batches according to the specified batch delay timing.

​
batchDelaySeconds
string
default:60

The delay between each batch of faxes in seconds, only used if enableBatchDelay is true, defaults to 60 seconds

Response

Accepted. Fax sending process initiated.

​
asyncResultId
string
required

The ID to track the asynchronous fax sending task.

⌘I