This function can be used to send multiple files as a fax to multiple recipients. The recipient information is uploaded through a CSV file. The user can specify additional details about the recipients as well as the fax broadcast job (schedule, cover page, user specified fields, etc.). The out parameters contain the job ID, estimated time in seconds till job starts and error information (if the job submission failed). This function requires a fax broadcast account.

Syntax

C# Copy imageCopy
bool SendFaxBroadcastEx(
    string UserID,
    string strPIN,
    base64Binary CSVFile,
    FaxJobFile[] FaxJobFiles,
    FaxBroadcastJob JobDetails,
    out string FaxJobId,
    out WSError WSError
)
Visual Basic Copy imageCopy
SendFaxBroadcastEx(
    ByVal UserID As String,
    ByVal strPIN As String,
    ByVal CSVFile() As Byte,
    ByVal FaxJobFiles() As FaxJobFile,
    ByVal JobDetails As FaxBroadcastJob,
    ByRef FaxJobId As String,
    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: c001234567890

strPIN

String

Required for username and password authentication

Deprecated. Use OAuth 2.0 and Authorization header for modern authentication

CSVFile

Base64Binary

Required

CSV file containing recipient details base64 encoded. See Broadcast CSV File Format

FaxJobFiles

FaxJobFile[]

Required

Array of FaxJobFile

JobDetails

FaxBroadcastJob

Required

Job level information about fax job.

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

FaxJobId

String

Return Error details.

WSError

WSError

Return error details.

Result

return

Boolean

True/False indicating result of method call

Code Examples

Detailed code examples for SendFaxBroadcastEx method

See Also