This function can be used to submit a report request for a previously submitted fax broadcast job using the job ID string. The out parameter contains error information (if the job submission failed). This function requires a fax broadcast account.

Syntax

C# Copy imageCopy
bool GetFaxBroadcastReport(
    string UserID,
    string strPIN,
    string JobId,
    int RecipientType,
    string RecipAddress,
    out WSError WSError
)
Visual Basic Copy imageCopy
GetFaxBroadcastReport(
    ByVal UserID As String,
    ByVal strPIN As String,
    ByVal JobId As String,
    ByVal RecipientType As Integer,
    ByVal RecipAddress 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: mbx1234567890

strPIN

String

Required for username and password authentication

Deprecated. Use OAuth 2.0 and Authorization header for modern authentication

JobId

String

Required

Return job information.

RecipientType

Integer

Required

Report recipient type: 1=email, 2=fax

RecipAddress

String

Required

Depending on the RecipientType, RecipAddress can either be an email address or a fax number. If RecipientType = 1 then RecipAddress requires a valid email address. If RecipientType = 2 then RecipAddress requires a valid Fax Number. Depending on RecipientType, the report will be either faxed or emailed to that destination.

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

WSError

WSError

Return Error details.

Result

return

bool

True/False indicating result of method call

Code Examples

Detailed code examples for GetFaxAccountSettings method

See Also