import os
from samplehc import SampleHealthcare
client = SampleHealthcare(
api_key=os.environ.get("SAMPLEHC_API_KEY"), # This is the default and can be omitted
)
response = client.v2.communication.send_fax(
document={
"id": "id",
"file_name": "fileName",
},
to="to",
)
print(response.async_result_id){
"asyncResultId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"statusCode": 123,
"details": {}
}{
"error": "<string>"
}{
"error": "<string>"
}Send fax
Initiates an asynchronous fax sending process. Returns an async result ID that can be used to track the status of the fax transmission.
import os
from samplehc import SampleHealthcare
client = SampleHealthcare(
api_key=os.environ.get("SAMPLEHC_API_KEY"), # This is the default and can be omitted
)
response = client.v2.communication.send_fax(
document={
"id": "id",
"file_name": "fileName",
},
to="to",
)
print(response.async_result_id){
"asyncResultId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"statusCode": 123,
"details": {}
}{
"error": "<string>"
}{
"error": "<string>"
}Body
The fax number to send the document to
The document to be sent via fax
Show child attributes
Show child attributes
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.
If enabled, the fax will be sent in batches according to the specified batch delay timing.
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.
The ID to track the asynchronous fax sending task.