This function can be used to send multiple files as a fax to multiple recipients. The user can specify additional details about the recipients. The out parameters contain the job IDs (one per recipient), estimated time in seconds till job starts and error information (if the job submission failed). This function requires a Fax Online or Fax Pro(100/300/1000) Account.

Syntax

C# Copy imageCopy
bool SendFax(
    string UserID,
    string strPIN,
    FaxJobRecipient[] Recipients,
    FaxJobFile[] FaxJobFiles,
    out FaxJobId[] FaxJobIds,
    out long TTFP,
    out WSError WSError
)
Visual Basic Copy imageCopy
SendFax(
    ByVal UserID As String,
    ByVal strPIN As String,
    ByVal Recipients() As FaxJobRecipient,
    ByVal FaxJobFiles() As FaxJobFile,
    ByRef FaxJobIds() As FaxJobId,
    ByRef TTFP As Long,
    ByRef WSError As WSError
) As Boolean

Parameters

Parameter

Type

Required?

Description

Input Header

Authorization

String

Required for OAuth 2.0 authorization

A string representing the authentication of the request via an access token in the format of Authorization: Bearer {AccessToken}.

Example: Authorization: Bearer M1Q0NjJvZ7Q5OPM2NDW1ZTCjOGZmYjI4

x-ch-request-id

String

Client generated unique identifier for tracking

Content-Type

String

Indicates the expected content type of the payload. Valid options are:

  • application/soap+xml for SOAP XML.

  • application/json for JSON.

If a value is not supplied then the default of application/soap+xml is used.

Input Body

UserID

String

Required

String representing the API Service User Id. Example: mbx1234567890

strPIN

String

Required for username and password authentication

Deprecated. Use OAuth 2.0 and Authorization header for modern authentication

Recipients

FaxJobRecipient[]

Required

Array of FaxJobRecipient details.

FaxJobFiles

FaxJobFile[]

Required

Array of FaxJobFile.

Output Header

x-ch-activity-id

String

Server generated unique identifier of tracking

x-ch-execution-time

String

Server execution time in milli-seconds

Output Body

FaxJobIds

FaxJobId[]

Return array of FaxJobId. Each recipient submitted will result in a return FaxJobId specific to that recipient.

TTFP

Long

Return estimated time in seconds before job will begin

WSError

WSError

Return Error details.

Result

return

Boolean

True/False indicating result of method call

Code Examples

Detailed code examples for SendFax method

See Also