This function can be used to query the current status of a previously submitted fax job using the job ID string. It can be used to query a single job’s status at a time. This function requires a Fax Online or Fax Pro(100/300/1000) Account.

Syntax

C# Copy imageCopy
long SimpleGetFaxStatus(
    string UserID,
    string strPIN,
    string JobId
)
Visual Basic Copy imageCopy
SimpleGetFaxStatus(
    ByVal UserID As String,
    ByVal strPIN As String,
    ByVal JobId As String
) As Long

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

JobId requesting status for (br string), can also specify as ‘JRI-ReferenceId’ to request status based on Reference Id. (JRI-REF1234 will lookup jobs with Reference Id ‘REF1234’)

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

Long

The job’s current status ID 1: Job Succeeded 2: Job Failed 3: Job is being processed -5019: Invalid Job ID

Code Examples

Detailed code examples for SimpleGetFaxStatus method

See Also