Test receiving a fax

Operation

testReceive

Parameters

Name Type Description
from_number Phone Number The phone number of the simulated sender. A 10 digit phone number in the United States or Canada. If one is not provided, 555-555-5555 will be used.
to_number Phone Number The phone number that is receiving the fax. Specifically, a Phaxio phone number you have purchased in your account that is 'receiving' the fax, or the public Phaxio fax number. Default is the public Phaxio fax number.
filename Binary Stream A PDF file containing a PhaxCode that you want to simulate receiving.
api_key string Your api key
api_secret string Your api secret

Sample Call

curl https://api.phaxio.com/v1/testReceive \
    -F 'filename=@/path/to/a/PDF/file' \
    -F 'api_key=API_KEY' \
    -F 'api_secret=API_SECRET'

Sample Response

{
    "success":true,
    "message":"Test fax received from +18773346654 to +18773346654.  Calling back now..."
}