This function can be used to send a TIFF file as a fax. It requires minimal information from the user and can be used to send faxes to a single recipient. This function requires a Fax Online or Fax Pro(100/300/1000) Account. Note: This method only supports TIFF. If you need to send a different document type you will need to use the SendFax or SendFaxEx method.

Syntax

C# Copy imageCopy
string SimpleSendFax(
    string UserID,
    string strPIN,
    string RecipientName,
    string FaxNumber,
    base64Binary TIFFJobFile
)
Visual Basic Copy imageCopy
SimpleSendFax(
    ByVal UserID As String,
    ByVal strPIN As String,
    ByVal RecipientName As String,
    ByVal FaxNumber As String,
    ByVal TIFFJobFile() As Byte
) As String

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

RecipientName

String

Required

The recipient’s name

FaxNumber

String

Required

The recipients fax number

TIFFJobFile

Base64Binary

Required

TIF file in Base64 encoded format

Output Header

x-ch-activity-id

String

Server generated unique identifier of tracking

x-ch-execution-time

String

Server execution time in milli-seconds

Result

return

String

Return Job ID assigned to this job. EX: br001h501r17j4054185

Code Examples

Detailed code examples for SinmpleSendFax method

See Also