Properties

Field

Type

Required?

Description

JobScheduleStartType

Integer

Required

1: Immediate, 2: Scheduled

JobScheduleStartDate

String

Optional

Scheduled start date & time for fax. See Date Time Format

JobExpiryDate

String

Optional

Expiry date & time for the fax. See Date Time Format

SenderCSID

String

Optional

Sender’s CSID

SenderName

String

Optional

Sender’s name

SenderCompany

String

Optional

Sender’s company

SenderPhone

String

Optional

Sender’s phone

CoverText

String

Optional

Cover page text.

CoverName

String

Optional

Cover page name. See Cover Page Selection

CoverSubject

String

Optional

Cover page subject

ReferenceId

String

Optional

User specified job ID

Resolution

String

Optional

"High" or "Low"

SenderFax

String

Optional

Sender’s fax number

SoftwareClient

String

Optional

4 digit string which can be used to specify the client software submitting this fax job.

NotifyType

Integer

Optional

Indicates the type of final notification required. Following are the possible values. 0 – No Push notification 1- Notify Via Email 2- HTTP Get 3- HTTP Post

NotifyIncludeDeliveredImage

Integer

Optional

Indicates if the email notification should also include the delivered image. This field can have the following values. 0 - Do not include delivered image 1 – Include delivered image on successful delivery only. 2 – Include delivered image on failed delivery only. 3 – Include delivered image on successful and failed delivery

NotifyDestination

String

Optional

Notify destination. For Notify type 1 (email), this filed can contain an email address. If no email address is specified, the contact email address of the account will be used. For Notify Type 2 and 3, this field may contain the destination hostname and port or a fully specified URL. If only a host name or IP address is specified, HTTP GET Template defined for this account will be used (Replacing Destination with the specified value) .

NotifyAuthUser

String

Optional

Basic Authenticate user id for HTTP Post and Get (Optional)

NotifyAuthPassword

String

Optional

Basic Authenticate password for HTTP post & Get (Optional)

UserField1

String

Optional

(Same as ReferenceId) If you assign ReferenceId then do not use this field.

UserField2

String

Optional

User specified field

UserField3

String

Optional

User specified field

UserField4

String

Optional

User specified field

UserField5

String

Optional

User specified field

UserField6

String

Optional

User specified field

UserField7

String

Optional

User specified field

UserField8

String

Optional

User specified field

UserField9

String

Optional

User specified field

UserField10

String

Optional

User specified field

UserField11

String

Optional

User specified field

UserField12

String

Optional

User specified field

See Also