Calculate Price

POST

/fax/price

Fax

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://rest.clicksend.com/v3/fax/price' \
--header 'Content-Type: application/json' \
--data-raw '{
    "file_url": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_public/_examples/document.pdf",
    "messages": [
        {
            "country": "AF",
            "custom_string": "custom_string",
            "from_email": "will@smith.com",
            "schedule": "1436874701",
            "source": "php",
            "to": "+61261111111"
        },
        {
            "country": "AF",
            "custom_string": "custom_string",
            "from_email": "john@doe.com",
            "schedule": "1436874701",
            "source": "php",
            "to": "+61261111122"
        }
    ]
}'

Response Example

{
    "data": {
        "_currency": {
            "currency_name_long": "Australian Dollars",
            "currency_name_short": "AUD",
            "currency_prefix_c": "c",
            "currency_prefix_d": "$"
        },
        "messages": [
            {
                "carrier": "",
                "country": "AU",
                "custom_string": "custom_string",
                "date_added": 1457504350,
                "from": "+61298441484",
                "from_email": "will@smith.com",
                "list_id": null,
                "message_id": "5106363A-AF38-4FB9-AF0E-B5FD38F62BDC",
                "message_pages": 0,
                "message_price": "0.0000",
                "schedule": "1436874701",
                "status": "SUCCESS",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "to": "+61261111111",
                "user_id": 1
            },
            {
                "carrier": "",
                "country": "AU",
                "custom_string": "custom_string",
                "date_added": 1457504350,
                "from": "+61298441484",
                "from_email": "john@doe.com",
                "list_id": null,
                "message_id": "6BBEB11E-CAA6-4B04-8537-63619F3D6B37",
                "message_pages": 6,
                "message_price": "13.2000",
                "schedule": "1436874701",
                "status": "SUCCESS",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "to": "+61261111122",
                "user_id": 1
            }
        ],
        "queued_count": 2,
        "total_count": 2,
        "total_price": 13.2
    },
    "http_code": 200,
    "response_code": "SUCCESS",
    "response_msg": "Fax queued for delivery."
}

Request

Body Params application/json

country

string

optional

Recipient country.

custom_string

string

optional

Your reference. Will be passed back with all replies and delivery reports.

file_url

string

required

Your URL to your PDF file.

from

string

optional

Your sender id. Must be a valid fax number.

from_email

string

optional

An email address where the reply should be emailed to.

list_id

number

optional

Your list ID if sending to a whole list. Can be used instead of 'to'.

messages

array

required

Your messages.

schedule

number

optional

Leave blank for immediate delivery. Your schedule time as a unix timestamp.

source

string

optional

Your method of sending e.g. 'wordpress', 'php', 'c#'.

string

required

Recipient number in E.164 format or local format (more info).

Examples

Responses

🟢200OK

application/json

Body

object {0}

Get Fax History

List of Fax Delivery Receipts