Core

Fax_SendFax

Method to send a fax.

Notes: See each field for details on what parameters you need.

  • You can use Numbers3...Numbers9999 to add more numbers
  • You can use Files1...Files99 to add more files. They will be combined in order.

Usage Details

post/Fax_SendFax/{RespEnc}

Request

  • Base URL
    https://api2.westfax.com/Polka.Api/REST
  • Auth
    none declared. Required headers: ContentType

Path parameters

RespEncstring required

json or xml

Headers

ContentTypestring required

Request body application/x-www-form-urlencoded

Usernamestring required

string username

Passwordstring required

string password

Cookiesboolean
ProductIdstring required

Guid Ex. 12345678-1234-1234-1234-123456789abc

JobNamestring required

(Optional) The Name of the Job

Headerstring

(Optional) The string to print at the top of the fax.

BillingCodestring

(Optional) Customer Billing Code

Numbers1string required

Destination Fax Number (1)

Numbers2integer

(Optional) Destination Fax Number (2)

Files0string required

The Fax file to send.

CSIDinteger

(Optional) The CSID to send. This is usually the Fax Number.

ANIinteger required

The Callers Phone number. This is usually the fax number.

StartDatestring

(Optional) The time to start the job.

FaxQualitystring

(Optional) The Fax Quality. Fine or Normal.

FeedbackEmailstring

(Optional) Send a report here when the job is done.

CallBackUrlstring

(Optional) Set a Callback URL for post send response. Use format [GET]https://test.com see Callback guide for more info.

Changes

No recorded changes to this operation across all 1 revision of this API.